Database Exist

Check if a database exists in the system.

When to use:

• Before creating a database to avoid conflicts
• Conditional database operations
• Database validation in applications

Definition

await zkdb
  .db(databaseName: string)
  .exist(): Promise<boolean>;

Parameters

• None

Returns

• Promise<boolean>: Returns true if the database exists, false otherwise.

Example

import { ZkDatabase } from 'zkdb';

const zkdb = await ZkDatabase.connect({
  userName: "chiro-user",
  privateKey: "EKFTciRxyxshZjimay9sktsn7v5PvmC5zPq7q4JnitHUytxUVnFP",
  environment: "node",
  // This URL is for test environment
  url: "https://api.zkdatabase.org/graphql",
});

await zkdb.auth.signIn();

// Check if database exists before creating
if (!(await zkdb.db('zkdb_test').exist())) {
  console.log('Database does not exist, creating...');
  await zkdb.db('zkdb_test').create({ merkleHeight: 20 });
} else {
  console.log('Database already exists');
}

// Check multiple databases
const databases = ['zkdb_test', 'zkdb_test2', 'zkdb_test3'];
for (const dbName of databases) {
  const exists = await zkdb.db(dbName).exist();
  console.log(`Database ${dbName}: ${exists ? 'exists' : 'not found'}`);
}

await zkdb.auth.signOut();

Result:

Database does not exist, creating...
Database zkdb_test: exists
Database zkdb_test2: not found  
Database zkdb_test3: exists

Related: create() | info()