Database SDK

A structured collection of data organized for efficient storage, retrieval, and management.

Import

import { $ } from 'sdk.do'

Operations

create

Initialize a new database with specified schema and configuration.

const result = await $.Database.create({
  // parameters
})

update

Modify database configuration, schema, or settings.

const result = await $.Database.update({
  // parameters
})

delete

Permanently remove the database and all contained data.

const result = await $.Database.delete({
  // parameters
})

backup

Create a point-in-time snapshot for disaster recovery.

const result = await $.Database.backup({
  // parameters
})

restore

Recover database data from a previous backup snapshot.

const result = await $.Database.restore({
  // parameters
})

migrate

Transfer database to a different version, engine, or location.

const result = await $.Database.migrate({
  // parameters
})

query

Execute read operations to retrieve data.

const result = await $.Database.query({
  // parameters
})

insert

Add new records or documents.

const result = await $.Database.insert({
  // parameters
})

updateRecords

Modify existing records or documents.

const result = await $.Database.updateRecords({
  // parameters
})

deleteRecords

Remove records matching specified criteria.

const result = await $.Database.deleteRecords({
  // parameters
})

index

Create optimized data structures to accelerate queries.

const result = await $.Database.index({
  // parameters
})

optimize

Improve performance through tuning or resource allocation.

const result = await $.Database.optimize({
  // parameters
})

Events

created

Triggered when a new database is initialized.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Database.created(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Database.created({ /* data */ })

updated

Triggered when database configuration or schema is modified.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Database.updated(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Database.updated({ /* data */ })

deleted

Triggered when a database is permanently removed.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Database.deleted(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Database.deleted({ /* data */ })

backedUp

Triggered when a backup snapshot is created.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Database.backedUp(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Database.backedUp({ /* data */ })

restored

Triggered when database is recovered from backup.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Database.restored(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Database.restored({ /* data */ })

migrated

Triggered when database migration completes.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Database.migrated(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Database.migrated({ /* data */ })

queried

Triggered when read operations retrieve data.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Database.queried(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Database.queried({ /* data */ })

inserted

Triggered when new records are added.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Database.inserted(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Database.inserted({ /* data */ })

recordsUpdated

Triggered when existing records are modified.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Database.recordsUpdated(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Database.recordsUpdated({ /* data */ })

recordsDeleted

Triggered when records are removed.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Database.recordsDeleted(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Database.recordsDeleted({ /* data */ })

indexed

Triggered when indexes are created or rebuilt.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Database.indexed(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Database.indexed({ /* data */ })

optimized

Triggered when performance improvements are applied.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Database.optimized(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Database.optimized({ /* data */ })

connectionLimitReached

Triggered when active connections reach maximum threshold.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Database.connectionLimitReached(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Database.connectionLimitReached({ /* data */ })

error

Triggered when operational failures occur.

import { on, send } from 'sdk.do'

// Subscribe to event
on.Database.error(async (data) => {
  console.log('Event received:', data)
})

// Emit event
await send.Database.error({ /* data */ })

Database SDK

On this page