Class Containers

constructor

• new Containers(database, clientContext): Containers

• Parameters

  • database: Database
  • clientContext: ClientContext

  Returns Containers

Readonlydatabase

create

• create(body, options?): Promise<ContainerResponse>

• Creates a container.

  A container is a named logical container for items.

  A database may contain zero or more named containers and each container consists of zero or more JSON items.

  Being schema-free, the items in a container do not need to share the same structure or fields.

  Since containers are application resources, they can be authorized using either the master key or resource keys.

  Parameters

  • body: ContainerRequest

    Represents the body of the container.
  • options: RequestOptions = {}

    Use to set options like response page size, continuation tokens, etc.

  Returns Promise<ContainerResponse>

createIfNotExists

• createIfNotExists(body, options?): Promise<ContainerResponse>

• Checks if a Container exists, and, if it doesn't, creates it. This will make a read operation based on the id in the body, then if it is not found, a create operation. You should confirm that the output matches the body you passed in for non-default properties (i.e. indexing policy/etc.)

  A container is a named logical container for items.

  A database may contain zero or more named containers and each container consists of zero or more JSON items.

  Being schema-free, the items in a container do not need to share the same structure or fields.

  Since containers are application resources, they can be authorized using either the master key or resource keys.

  Parameters

  • body: ContainerRequest

    Represents the body of the container.
  • Optionaloptions: RequestOptions

    Use to set options like response page size, continuation tokens, etc.

  Returns Promise<ContainerResponse>

query

• query(query, options?): QueryIterator<any>

• Queries all containers.

  Parameters

  • query: SqlQuerySpec

    Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
  • Optionaloptions: FeedOptions

    Use to set options like response page size, continuation tokens, etc.

  Returns QueryIterator<any>

  QueryIterator Allows you to return specific containers in an array or iterate over them one at a time.

  Example: Read all containers to array.

  const querySpec: SqlQuerySpec = {
    query: "SELECT * FROM root r WHERE r.id = @container",
    parameters: [
      {name: "@container", value: "Todo"}
    ]
  };
  const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll();
  Copy

• query<T>(query, options?): QueryIterator<T>

• Queries all containers.

  Type Parameters

  • T

  Parameters

  • query: SqlQuerySpec

    Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
  • Optionaloptions: FeedOptions

    Use to set options like response page size, continuation tokens, etc.

  Returns QueryIterator<T>

  QueryIterator Allows you to return specific containers in an array or iterate over them one at a time.

  Example: Read all containers to array.

  const querySpec: SqlQuerySpec = {
    query: "SELECT * FROM root r WHERE r.id = @container",
    parameters: [
      {name: "@container", value: "Todo"}
    ]
  };
  const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll();
  Copy

readAll

• readAll(options?): QueryIterator<ContainerDefinition & Resource>

• Read all containers.

  Parameters

  • Optionaloptions: FeedOptions

    Use to set options like response page size, continuation tokens, etc.

  Returns QueryIterator<ContainerDefinition & Resource>

  QueryIterator Allows you to return all containers in an array or iterate over them one at a time.

  Example: Read all containers to array.

  const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll();
  Copy