Setu-TS
    Preparing search index...

    Interface CosmosDatabaseOptions

    The arm selecting the Cosmos adapter over the @azure/cosmos SDK — Azure Cosmos DB's NoSQL (SQL) API.

    options.database is required, and options.endpoint + options.key are required unless options.client is supplied, so a registration that forgets them is a compile error instead of a connect() throw — the guarantee every other built-in arm gives.

    Cosmos DB's MongoDB API is a different wire protocol and is served by the MongoDatabaseOptions arm pointed at a Cosmos connection string, not by this one.

    import { DatabasePlugin } from '@setu-ts/database-plugin';

    DatabasePlugin({
      type: 'cosmos',
      options: {
        endpoint: 'https://my-account.documents.azure.com:443/',
        key: cosmosKey,
        database: 'app',
      },
    });

    0.2.0

    interface CosmosDatabaseOptions {
        name?: string;
        options: CosmosAdapterOptions;
        readiness?: DatabaseReadinessOptions;
        type: "cosmos";
    }

    Hierarchy (View Summary)

    Index
    name? options readiness? type
    name?: string

    Named connection for multi-database support. Defaults to 'default'.

    When a name is provided, the service registers under database.<name> (e.g. database.primary); otherwise it uses the canonical CAPABILITIES.DATABASE token. Dot notation, not a colon: createCapabilityToken rejects colons.

    0.1.0

    options: CosmosAdapterOptions

    Cosmos adapter configuration; database and one credential form are required.

    readiness?: DatabaseReadinessOptions

    Optional schema readiness, evaluated by this connection's health indicator.

    0.10.0

    type: "cosmos"

    Selects the Cosmos arm.

    Settings
    Member Visibility

    On This Page
    Properties