Skip to main content

Document Metadata

Access metadata information for a document.

Definition​

await zkdb
  .db(databaseName: string)
  .collection(collectionName: string)
  .findOne(filter: Record<string, any>)
  .metadata.info(): Promise<Result<TDocumentMetadataResponse>>;

Parameters​

  • None

Returns​

  • Promise<Result<TDocumentMetadataResponse>>: Returns comprehensive document metadata including creation timestamp, last modification date, owner information, permission settings, and version history. This provides complete administrative and audit information for document lifecycle management.
type TDocumentMetadataResponse = {
  docId: string;
  createdAt: string;
  updatedAt: string;
  owner: string;
  permission: number;
};

Example​

import { ZkDatabase } from 'zkdb';

const zkdb = new ZkDatabase({
  apiKey: 'zkdb_536aac02a1b7.c001b6b8f...da3aa4185d8d2ad07f0ae94aT',
  // This URL is for test environment
  url: "https://serverless.zkdatabase.org/graphql", 
});
const dbTest = zkdb.db('zkdb_test');
const collection = dbTest.collection('Shirt');
const doc = (await collection.findOne({ name: 'Shirt 1' })).unwrap();
if (doc) {
  const metadata = (await doc.metadata.info()).unwrap();
  console.log('Document metadata:', metadata);
}

Result:​

{
  "docId": "6t7...",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-02T00:00:00.000Z",
  "owner": "chiro-user",
  "permission": 983296
}