EmojiDB - GitLite

KO | EN

gitlite — search

#python #react #typescript #go #golang #machine-learning #deep-learning #linux #macos #windows #awesome #cli #openai #open-source

EmojiDB

(★ 130)

Database, but encrypted using emojis

파일 탐색기

최종 버전 다운로드 (.zip)

- - emojidb-darwin-arm64
  - emojidb-darwin-x64
  - emojidb-linux-arm64
  - emojidb-linux-x64
  - emojidb-win32-arm64.exe
  - emojidb-win32-x64.exe
- - main.go
- db.go
- mem.go
- schema.go
- crypto.go
- node_showcase.db.schema.json
- - file.svg
  - globe.svg
  - next.svg
  - og-image.png
  - vercel.svg
  - window.svg
- .gitignore
- eslint.config.mjs
- next.config.mjs
- package-lock.json
- package.json
- postcss.config.mjs
- README.md
- tsconfig.json
- query.go
- safety.go
- safety_api.go
- build_all.sh
- release.sh
- - emojidb-darwin-arm64
- .npmignore
- index.d.ts
- index.js
- install.js
- package.json
- README.md
- test.js
- storage.go
- - showcase.db.schema.json
- crypto_test.go
- db_test.go
- dump.json
- full_integration_test.go
- mem_test.go
- query_test.go
- safety_test.go
- storage_test.go
.gitignore
emojidb-darwin-arm64
emojidb-engine
go.mod
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# EmojiDB

**High-performance encrypted database engine with Node.js SDK**

EmojiDB is an embedded database written in Go that encrypts all data, headers, and schemas into emoji sequences. Features automatic binary downloads, schema evolution, and military-grade encryption.

## Quick Start

### Installation
```bash
npm install @ikwerre-dev/emojidb
```

The engine binary is automatically downloaded for your platform (Mac, Linux, Windows).

### Basic Usage
```javascript
import EmojiDB from '@ikwerre-dev/emojidb';

const db = new EmojiDB();
await db.connect();
await db.open('my_app.db', 'super-secret-key');
```

## Schema Management

Define schemas before storing data to enforce structure and data integrity.

### Defining Schemas
```javascript
await db.defineSchema('users', [
    { Name: 'id',       Type: 0, Unique: true  },
    { Name: 'username', Type: 1, Unique: true  }
]);
```

### Field Types
| Type ID | Data Type | Example |
|---------|-----------|---------|
| `0` | Integer | `123` |
| `1` | String | `"robinson"` |
| `2` | Boolean | `true` |
| `3` | Float | `10.5` |
| `4` | Map | `{ "a": 1 }` |

Schemas are persisted as readable JSON files in `emojidb/*.schema.json`.

## Schema Evolution

### Automatic Migration
```javascript
await db.migrate();
```
Syncs all tables from your local `emojidb/*.schema.json` file.

### Explicit Migration
```javascript
await db.migrate('users', [...fields]);
```

### Force Migration (Destructive)
```javascript
await db.migrate('users', true);
```
Validates all rows and drops any that don't match the new schema or contain duplicates.

### Pull Schema
```javascript
await db.pull();
```
Regenerates local schema files from the current database state.

## Data Operations

### Insert
```javascript
await db.insert('users', {
    id: 1,
    username: 'emoji_king',
    active: true
});
```

### Query
```javascript
const users = await db.query('users', { id: 1 });
console.log(users);
// Output: [{ id: 1, username: 'emoji_king', active: true }]
```

### Update
```javascript
await db.update('users', { id: 1 }, { username: 'robinson_honour' });
```

### Delete
```javascript
await db.delete('users', { id: 1 });
```

## Utilities

### Count Records
```javascript
const count = await db.count('users', { active: true });
```

### Drop Table
```javascript
await db.dropTable('logs');
```

### Force Persist to Disk
```javascript
await db.flush('users');
```

## Security

EmojiDB provides military-grade encryption:

- **AES-GCM Encryption**: All data encrypted at rest
- **Emoji Encoding**: Ciphertext encoded as emojis for obfuscation
- **Master Key Rotation**: Built-in support via `db.rekey()`

### Security Files
All database artifacts are stored in the `emojidb/` directory:
- `*.db`: Encrypted data
- `*.safety`: Crash recovery logs
- `secure.pem`: Optional master key file

## Platform Support

Automated builds for:
- **macOS**: ARM64 (M1/M2/M3) and Intel x64
- **Linux**: x64 and ARM64
- **Windows**: x64 and ARM64

---

*Built by Robinson Honour*