Documents

Create, update, query and delete documents in a collection.

Documents store your application data as JSON objects. Every document belongs to a collection.

Create a Document

Insert a new document into a collection.

const document = await db.documents.create(
	users.id,
	{
		data: {
			name: "John Doe",
			email: "john@example.com",
			age: 25,
		},
	},
);

Parameters

collectionId (string) — Collection identifier.
data (object) — Document contents.

Returns

{
	id: "doc_01JY...",
	data: {
		name: "John Doe",
		email: "john@example.com",
		age: 25,
	},
	createdAt: "2026-07-11T10:32:18Z",
	updatedAt: "2026-07-11T10:32:18Z",
}

List Documents

Retrieve every document in a collection.

const documents = await db.documents.list(
	users.id,
);

Find a Document

Retrieve a document by its ID.

const document = await db.documents.find(
	users.id,
	document.id,
);

Update a Document

Update an existing document.

const updated = await db.documents.update(
	users.id,
	document.id,
	{
		data: {
			name: "Jane Doe",
			email: "jane@example.com",
			age: 30,
		},
	},
);

Only the provided fields are updated.

Query Documents

Filter documents using the CassaDB query language.

const adults = await db.documents.query(
	users.id,
	{
		where: "age >= 18",
	},
);

Query Example

const verified = await db.documents.query(
	users.id,
	{
		where: "verified = true",
	},
);

Delete a Document

Delete a document by its ID.

await db.documents.delete(
	users.id,
	document.id,
);

Deleted documents cannot be recovered.

Complete Example

const document = await db.documents.create(
	users.id,
	{
		data: {
			name: "John Doe",
			email: "john@example.com",
		},
	},
);

await db.documents.update(
	users.id,
	document.id,
	{
		data: {
			name: "Jane Doe",
		},
	},
);

const results = await db.documents.query(
	users.id,
	{
		where: "name = 'Jane Doe'",
	},
);

await db.documents.delete(
	users.id,
	document.id,
);