nildb.builder_client

Builder NIL DB client implementation.

class NilDbBuilderClientOptions(*, about: ReadAboutNodeResponse, base_url: str)

Bases: NilDbBaseClientOptions

Options for NIL DB builder client.

class NilDbBuilderClient(options: NilDbBuilderClientOptions)

Bases: NilDbBaseClient

Builder NIL DB client implementation.

async register(body: RegisterBuilderRequest) → None

Register a new builder.

async read_profile(token: str) → ReadBuilderProfileResponse

Retrieve the authenticated builder’s profile information.

async update_profile(token: str, body: UpdateBuilderProfileRequest) → None

Update the authenticated builder’s profile information.

async delete_builder(token: str) → None

Delete the authenticated builder and all associated resources.

async create_collection(token: str, body: CreateCollectionRequest) → None

Create a new collection for data validation.

async read_collections(token: str) → ListCollectionsResponse

List all collections owned by the authenticated builder.

async delete_collection(token: str, collection: str) → None

Delete a collection by id and all associated data.

async read_collection(token: str, collection: str) → ReadCollectionMetadataResponse

Retrieve a collection by id including metadata.

async create_collection_index(token: str, collection: str, body: CreateCollectionIndexRequest) → None

Create an index on a collection.

async drop_collection_index(token: str, collection: str, index: str) → None

Drop an index from a collection.

async get_queries(token: str) → ReadQueriesResponse

List all queries owned by the authenticated builder.

async get_query(token: str, query: str) → ReadQueryResponse

Retrieve a query by id.

async create_query(token: str, body: CreateQueryRequest) → None

Create a new MongoDB aggregation query with variable substitution.

async delete_query(token: str, query: str) → None

Delete a query by id.

async run_query(token: str, body: RunQueryRequest) → RunQueryResponse

Execute a query with variable substitution.

async read_query_run_results(token: str, run: str) → ReadQueryRunByIdResponse

Retrieve the status and results of a background query job.

async create_standard_data(token: str, body: CreateStandardDataRequest) → CreateDataResponse

Upload standard data records to a schema-validated collection.

async find_data(token: str, body: FindDataRequest) → FindDataResponse

Search for data matching the provided filter.

async update_data(token: str, body: UpdateDataRequest) → UpdateDataResponse

Update data records matching the provided filter.

async delete_data(token: str, body: DeleteDataRequest) → DeleteDataResponse

Delete data records matching the provided filter.

async flush_data(token: str, collection: str) → None

Remove all data from a collection.

async tail_data(token: str, collection: str, limit: int = 10) → TailDataResponse

Retrieve the most recent data records from a collection.

async create_nil_db_builder_client(base_url: str) → NilDbBuilderClient

Create a NIL DB builder client.

Parameters:

base_url – Base URL for the NIL DB service

Returns:

NIL DB builder client