r (root)

​

Syntax

r → builder

​

Arguments

​

Optargs

​

Returns

​

Behavior

• The r object is the starting point for all RuloDB queries.
• Provides access to database operations, table operations, and utility functions.
• All queries must begin with r followed by the appropriate method chain.

​

Notes & Caveats

• The r object is imported from the RuloDB SDK.
• Queries built with r are not executed until .run(client) is called.

​

Example

​

Basic query building

import { Client, r } from '@rulodb/rulodb';

const client = new Client();
await client.connect();

// Use `r` to build a query
await r.dbCreate('myDb').run(client);

​

Query chaining

await r
  .table('users')
  .filter((doc) => doc.age.ge(18))
  .run(client);

​

Database operations

// List all databases
const cursor = await r.dbList().run(client);
const databases = await cursor.toArray();

// Select a specific database
await r.db('myApp').tableCreate('users').run(client);

​

Related Functions

• db - Referencing a Database
• dbCreate - Create a Database
• dbDrop - Drop a Database
• dbList - List Databases
• table - Referencing a Table
• tableCreate - Create a Table
• tableDrop - Drop a Table
• tableList - List Tables