@atek-cloud/adb-api
Advanced tools
atek.cloud/adb-api
npm install @atek-cloud/adb-api
import adb from '@atek-cloud/adb-api'
import cats from 'example-cats-table'
// get or create a database under the 'mydb' alias
const db = adb.db('mydb')
// use the cats table
await cats(db).create({id: 'kit', name: 'Kit'})
await cats(db).list() // => {records: [{key: 'kit', value: {id: 'kit', name: 'Kit', createdAt: '2021-09-07T01:06:07.487Z'}}]}
await cats(db).get('kit') // => {key: 'kit', value: {id: 'kit', name: 'Kit', createdAt: '2021-09-07T01:06:07.487Z'}}
await cats(db).put('kit', {id: 'kit', name: 'Kitty'})
await cats(db).delete('kit')
See The Atek DB Guide to learn how to use ADB.
| Name | Type |
|---|---|
.api | AdbApi & AtekRpcClient |
.db | (dbId: string | DbSettings, opts?: DbSettings) => AdbDatabase |
Use the .db() method to create AdbDatabase instances. You may pass a Hypercore 64-character hex-string key or an arbitrary string (which will be a local alias).
import adb from '@atek-cloud/adb-api'
// get or create a database under the 'mydb' alias
// - the 'mydb' alias will be stored under this application for easy future access
const db = adb.db('mydb')
// get a database under its Hypercore key
// - if the database does not exist locally, its content will be fetched from the p2p network
const db2 = adb.db('97396e81e407e5ae7a64b375cc54c1fc1a0d417a5a72e2169b5377506e1e3163')
The .api is the RPC interface which will be used by .db().
▸ createClient(): AdbApi & AtekRpcClient
AdbApi & AtekRpcClient
Use this method to create additional instances of the RPC interface, if needed.
import { createClient } from '@atek-cloud/adb-api'
const adbApi = createClient()
// adbApi is another instance of the default export's adb.api
▸ createServer(handlers): AtekRpcServer
| Name | Type |
|---|---|
handlers | any |
AtekRpcServer
Use this method to create an ADB server API. You'll only need this if you're creating an alternative implementation to the main ADB.
▸ defineTable<T>(tableId, desc): (db: AdbDatabase) => any
| Name | Type |
|---|---|
T | extends object |
| Name | Type |
|---|---|
tableId | string |
desc | TableSettings |
fn
▸ (db): AdbTable<T>
| Name | Type |
|---|---|
db | AdbDatabase |
Creates a table API which can be called on databases:
import adb, { defineTable } from '@atek-cloud/adb-api`
// provide a typescript interface for the records
interface CatRecord {
id: string
name: string
createdAt: string
}
// define the cats table
const catsTable = defineTable<CatRecord>({
id: 'example.com/cats',
schema: {
type: 'object',
required: ['id', 'name']
properties: {
id: {type: 'string'},
name: {type: 'string'},
createdAt: {type: 'string', format: 'date-time'}
}
},
templates: {
table: {
title: 'Cats',
description: 'A table for tracking my cats'
},
record: {
key: '{{/id}}',
title: 'Kitty: {{/name}}'
}
}
})
// use the cats table
const db = adb.db('mydb')
await cats(db).create({id: 'kit', name: 'Kit'})
await cats(db).list() // => {records: [{key: 'kit', value: {id: 'kit', name: 'Kit', createdAt: '2021-09-07T01:06:07.487Z'}}]}
await cats(db).get('kit') // => {key: 'kit', value: {id: 'kit', name: 'Kit', createdAt: '2021-09-07T01:06:07.487Z'}}
await cats(db).put('kit', {id: 'kit', name: 'Kitty'})
await cats(db).delete('kit')
• new AdbDatabase(api, dbId, opts?)
| Name | Type |
|---|---|
api | AdbApi |
dbId | string |
opts? | DbSettings |
• isReady: undefined | Promise<any>
• api: AdbApi
• dbId: string
▸ describe(): Promise<DbDescription>
desc Get metadata and information about the database.
Promise<DbDescription>
▸ define(tableId, desc): Promise<TableDescription>
desc Register a table's schema and metadata.
| Name | Type |
|---|---|
tableId | string |
desc | TableSettings |
Promise<TableDescription>
▸ list(tableId, opts?): Promise<Object>
desc List records in a table.
| Name | Type |
|---|---|
tableId | string |
opts? | ListOpts |
Promise<Object>
▸ get(tableId, key): Promise<Record<object>>
desc Get a record in a table.
| Name | Type |
|---|---|
tableId | string |
key | string |
Promise<Record<object>>
▸ create(tableId, value, blobs?): Promise<Record<object>>
desc Add a record to a table.
| Name | Type |
|---|---|
tableId | string |
value | object |
blobs? | BlobMap |
Promise<Record<object>>
▸ put(tableId, key, value): Promise<Record<object>>
desc Write a record to a table.
| Name | Type |
|---|---|
tableId | string |
key | string |
value | object |
Promise<Record<object>>
▸ delete(tableId, key): Promise<void>
desc Delete a record from a table.
| Name | Type |
|---|---|
tableId | string |
key | string |
Promise<void>
▸ diff(opts): Promise<Diff[]>
desc Enumerate the differences between two versions of the database.
| Name | Type |
|---|---|
opts | Object |
opts.left | number |
opts.right? | number |
opts.tableIds? | string[] |
Promise<Diff[]>
▸ getBlob(tableId, key, blobName): Promise<Blob>
desc Get a blob of a record.
| Name | Type |
|---|---|
tableId | string |
key | string |
blobName | string |
Promise<Blob>
▸ putBlob(tableId, key, blobName, blobValue): Promise<void>
desc Write a blob of a record.
| Name | Type |
|---|---|
tableId | string |
key | string |
blobName | string |
blobValue | BlobDesc |
Promise<void>
▸ delBlob(tableId, key, blobName): Promise<void>
desc Delete a blob of a record.
| Name | Type |
|---|---|
tableId | string |
key | string |
blobName | string |
Promise<void>
• new AdbTable<T>(db, tableId, tableDesc)
| Name | Type |
|---|---|
T | extends object |
| Name | Type |
|---|---|
db | AdbDatabase |
tableId | string |
tableDesc | TableSettings |
• isReady: Promise<any>
• db: AdbDatabase
• tableId: string
• tableDesc: TableSettings
▸ list(opts?): Promise<Object>
desc List records in the table.
| Name | Type |
|---|---|
opts? | ListOpts |
Promise<Object>
▸ get(key): Promise<Record<T>>
desc Get a record in the table.
| Name | Type |
|---|---|
key | string |
Promise<Record<T>>
▸ create(value, blobs?): Promise<Record<T>>
desc Add a record to the table.
| Name | Type |
|---|---|
value | T |
blobs? | BlobMap |
Promise<Record<T>>
▸ put(key, value): Promise<Record<T>>
desc Write a record to the table.
| Name | Type |
|---|---|
key | string |
value | T |
Promise<Record<T>>
▸ delete(key): Promise<void>
desc Delete a record from the table.
| Name | Type |
|---|---|
key | string |
Promise<void>
▸ diff(opts): Promise<Diff[]>
desc Enumerate the differences between two versions of the database.
| Name | Type |
|---|---|
opts | Object |
opts.left | number |
opts.right? | number |
Promise<Diff[]>
▸ getBlob(key, blobName): Promise<Blob>
desc Get a blob of a record.
| Name | Type |
|---|---|
key | string |
blobName | string |
Promise<Blob>
▸ putBlob(key, blobName, blobValue): Promise<void>
desc Write a blob of a record.
| Name | Type |
|---|---|
key | string |
blobName | string |
blobValue | BlobDesc |
Promise<void>
▸ delBlob(key, blobName): Promise<void>
desc Delete a blob of a record.
| Name | Type |
|---|---|
key | string |
blobName | string |
Promise<void>
FAQs
Atek DB API
The npm package @atek-cloud/adb-api receives a total of 0 weekly downloads. As such, @atek-cloud/adb-api popularity was classified as not popular.
We found that @atek-cloud/adb-api demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.