aoi.db

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 10 Open GitHub ↗

No description available.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">@aoijs/aoi.db</h1>

[![Discord Server](https://img.shields.io/discord/773352845738115102?color=5865F2&logo=discord&logoColor=white)](https://discord.com/invite/HMUfMXDQsV)
[![NPM Downloads](https://img.shields.io/npm/dt/@aoijs/aoi.db.svg?maxAge=3600)](https://www.npmjs.com/package/@aoijs/aoi.db)
[![NPM Version](https://img.shields.io/npm/v/@aoijs/aoi.db.svg?maxAge=3600)](https://www.npmjs.com/package/@aoijs/aoi.db)

</div>

## Table Of Contents

- [Table Of Contents](#table-of-contents)
- [About](#about)
- [Installation](#installation)
- [Types](#types)
- [Setups](#setups)
  - [KeyValue](#keyvalue)
  - [WideColumn](#widecolumn)
  - [Remote](#remote)
    - [Setting up the database server](#setting-up-the-database-server)
    - [Setting up the client](#setting-up-the-client)
- [Links](#links)

## About

Aoi.db is a collection of various database types to handle various types of data requirements!

## Installation

```bash
#npm
npm i @aoijs/aoi.db

#yarn
yarn add @aoijs/aoi.db
```

## Types

> - KeyValue - A simple database that stores key value pairs
>   - Usage: general purpose

> - WideColumn - A database that stores data in a column
>   - Usage: good for getting separate columns related to a primary column

> - Remote - A database that stores data in a remote server
>   - Usage: good for separating database extensive usage from main project/process

## Setups

### KeyValue

```ts
const { KeyValue } = require("@aoijs/aoi.db"); //commonjs
// or
import { KeyValue } from "@aoijs/aoi.db"; //esm

// Basic Setup
const db = new KeyValue({
  dataConfig: { path: "./database" },
  encryptionConfig: {
    encriptData: false,
    securityKey: "a-32-characters-long-string-here",
  },
  debug: true,
});

db.on("ready", () => {
  console.log("Database is ready!");
});

db.connect();
```

Reference: [KeyValue](https://akaruidevelopment.github.io/aoi.db/classes/KeyValue.html)

### WideColumn

```ts
const { WideColumn, Column } = require("@aoijs/aoi.db"); //commonjs
// or
import { WideColumn, Column } from "@aoijs/aoi.db"; //esm

// Basic Setup

const prime = new Column({
  name: "id",
  primary: true,
  type: "bigint",
  default: 0n,
});
const xp = new Column({
  name: "xp",
  type: "number",
  primary: false,
  sortOrder: "DESC",
  default: 0,
});

const db = new WideColumn({
  path: "./path/",
  encryptionConfig: {
    securityKey: "a-32-characters-long-string-here",
  },
  tables: [
    {
      name: "main",
      columns: [prime, xp],
    },
  ],
});

db.on("ready", () => {
  console.log("Database is ready!");
});

db.connect();
```

Reference: [WideColumn](https://akaruidevelopment.github.io/aoi.db/classes/WideColumn.html)

### Remote

#### Setting up the database server

```js
const { Receiver } = require("@aoijs/aoi.db"); //commonjs
// or
import { Receiver } from "@aoijs/aoi.db"; //esm

const rec = new Receiver({
  logEncrypt: "a-32-characters-long-string-here",
  logPath: "./logPath/",
  wsOptions: {
    port: portNo, // 443 for ssl wss and 80 for ws
    clientTracking: true,
  },
  whitelistedIps: "*",
});

rec.on("connect", () => {
  console.log("connected");
});

rec.connect();
```

Reference: [Receiver](https://akaruidevelopment.github.io/aoi.db/classes/Receiver.html)

#### Setting up the client

```js
const { Transmitter, TransmitterFlags } = require("@aoijs/aoi.db"); //commonjs
// or
import { Transmitter, DatabaseEvents } from "@aoijs/aoi.db"; //esm

const db = Transmitter.createConnection({
    path: `aoidb://usersatoshi:123456@localhost:8080`,
    dbOptions: {
        type: "KeyValue",
        options: {
            dataConfig: {
                path: "./database",
            },
            encryptionConfig: {
                securityKey: "a-32-characters-long-string-here"
            }
        }
    }
})

//or

const db = new Transmitter({
    dbOptions: {
        type: "KeyValue",
        options: {
            dataConfig: {
                path: "database",
            },
            encryptionConfig: {
                securityKey: "a-32-characters-long-string-here"
            }
        }
    },
    username: "username",
    password: "password",
})

db.on(DatabaseEvents.Connect, () => console.log("Connected"));
db.on(DatabaseEvents.Disconnect, () => console.log("Disconnected"));
db.connect();
```

Reference: [Transmitter](https://akaruidevelopment.github.io/aoi.db/classes/Transmitter.html)

## Links

- [Documentation](https://aoijs.github.io/aoi.db/)
- [Discord Server](https://discord.com/invite/HMUfMXDQsV)
- [NPM](https://www.npmjs.com/package/@aoijs/aoi.db)
- [Github](https://github.com/aoijs/aoi.db)

aoi.db

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README