# aoi.db > aoi.db - Database Management System with different types of databases. Latest version **1.1.1** (published 2023-06-16) · MIT license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install aoi.db pnpm add aoi.db yarn add aoi.db bun add aoi.db ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 1.1.1 | | Published | 2023-06-16 | | First published | 2022-08-04 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >=16.x | | Dependencies | 1 | | Unpacked size | 568.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 10 | | Author | Leref | | Maintainers | leref, usersatoshi | | Keywords | aoi.db, aoidb, dbd.js, dbdjs, dbd, aoi.js, aoi, json, database, discord | ## Links - npm: https://www.npmjs.com/package/aoi.db - Repository: https://github.com/leref/aoi.db - Homepage: https://leref.github.io/aoi.db/ - Issues: https://github.com/Leref/aoi.db/issues - npm.io page: https://npm.io/package/aoi.db ## Dependencies (1) - [tiny-typed-emitter](https://npm.io/package/tiny-typed-emitter.md) ^2.1.0 ## Alternatives - [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads - [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads - [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads - [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads - [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads ## Recent versions - 1.1.1 (latest) — 2023-06-16 - 1.1.0 — 2023-03-27 - 1.0.0 — 2022-08-04 ## README

aoi.db

[![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/aoi.db.svg?maxAge=3600)](https://www.npmjs.com/package/aoi.db) [![NPM Version](https://img.shields.io/npm/v/aoi.db.svg?maxAge=3600)](https://www.npmjs.com/package/aoi.db)
## 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 aoi.db #yarn yarn add aoi.db #edge npm i https://github.com/leref/aoi.db#main ``` ## 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("aoi.db") //commonjs // or import { KeyValue } from "aoi.db" //esm // Basic Setup const db = new KeyValue({ path: "./path/", tables: ["table"], }); db.on("ready", () => { console.log("Database is ready!"); }); db.connect(); ``` Reference: [KeyValue](https://leref.github.io/aoi.db/classes/KeyValue.html) ### WideColumn ```ts const { WideColumn, Column } = require("aoi.db") //commonjs // or import { WideColumn, Column } from "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/", encryptOption: { 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://leref.github.io/aoi.db/classes/WideColumn.html) ### Remote #### Setting up the database server ```js const { Receiver } = require("aoi.db"); //commonjs // or import { Receiver } from "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://leref.github.io/aoi.db/classes/Receiver.html) #### Setting up the client ```js const { Transmitter, TransmitterFlags } = require("aoi.db"); //commonjs // or import { Transmitter, TransmitterFlags } from "aoi.db"; //esm const db = new Transmitter({ path: "websocket path", //path : "ws://localhost:80", databaseType: "KeyValue or WideColumn", dbOptions: { path: "./databasePath in remote server/", encryptOption: { securitykey: "a-32-characters-long-string-here", enabled: true, }, }, name: "username", pass: "password", flags: TransmitterFlags.READ_WRITE, //READ_WRITE, READ_ONLY, WRITE_ONLY tables: ["table"], }); db.on("ready", () => { console.log("ready"); }); db.on("close", (code, reason) => { console.log("[TRANSMITTER] => " + code + " " + reason); }); db.connect(); ``` Reference: [Transmitter](https://leref.github.io/aoi.db/classes/Transmitter.html) ## Links - [Documentation](https://leref.github.io/aoi.db/) - [Discord Server](https://discord.com/invite/HMUfMXDQsV) - [NPM](https://www.npmjs.com/package/aoi.db) - [Github](https://github.com/leref/aoi.db) --- _Source: https://npm.io/package/aoi.db · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._