Share via

Containers class

  • Referencia
Paquete:
@azure/cosmos

Operaciones para crear nuevos contenedores y leer y consultar todos los contenedores

Consulte Contenedor para leer, reemplazar o eliminar un contenedor existente; use .container(id).

Nota: todas estas operaciones realizan llamadas con un presupuesto fijo. Debe diseñar el sistema de forma que estas llamadas escalen de forma sublineal con la aplicación. Por ejemplo, no llame a containers.readAll() antes de cada item.read() llamada, para asegurarse de que el contenedor existe; hálo una vez en el inicio de la aplicación.

Constructores

Containers(Database, ClientContext)

Propiedades

database

Métodos

create(ContainerRequest, RequestOptions)

Crea un contenedor.

Un contenedor es un contenedor lógico con nombre para los elementos.

Una base de datos puede contener cero o más contenedores con nombre y cada contenedor consta de cero o más elementos JSON.

Sin esquemas, los elementos de un contenedor no necesitan compartir la misma estructura o campos.

Dado que los contenedores son recursos de aplicación, se pueden autorizar mediante la clave maestra o las claves de recursos.
createIfNotExists(ContainerRequest, RequestOptions)

Comprueba si existe un contenedor y, si no lo hace, lo crea. Esto hará que una operación de lectura se base en el identificador de body, si no se encuentra, una operación de creación. Debe confirmar que la salida coincide con el cuerpo que pasó para las propiedades no predeterminadas (es decir, la directiva de indexación/etc.).

Un contenedor es un contenedor lógico con nombre para los elementos.

Una base de datos puede contener cero o más contenedores con nombre y cada contenedor consta de cero o más elementos JSON.

Sin esquemas, los elementos de un contenedor no necesitan compartir la misma estructura o campos.

Dado que los contenedores son recursos de aplicación, se pueden autorizar mediante la clave maestra o las claves de recursos.
query(SqlQuerySpec, FeedOptions)

Consulta todos los contenedores.

Ejemplo

Lee todos los contenedores en la matriz. * typescript * 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(); *

query<T>(SqlQuerySpec, FeedOptions)

Consulta todos los contenedores.

Ejemplo

Lee todos los contenedores en la matriz. * typescript * 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(); *

readAll(FeedOptions)

Lee todos los contenedores.

Ejemplo

Lee todos los contenedores en la matriz. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

Detalles del constructor

Containers(Database, ClientContext) 

new Containers(database: Database, clientContext: ClientContext)

Parámetros

database
Database
clientContext

ClientContext

Detalles de las propiedades

database 

database: Database

Valor de propiedad

Database

Detalles del método

create(ContainerRequest, RequestOptions)

Crea un contenedor.

Un contenedor es un contenedor lógico con nombre para los elementos.

Una base de datos puede contener cero o más contenedores con nombre y cada contenedor consta de cero o más elementos JSON.

Sin esquemas, los elementos de un contenedor no necesitan compartir la misma estructura o campos.

Dado que los contenedores son recursos de aplicación, se pueden autorizar mediante la clave maestra o las claves de recursos.

function create(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>

Parámetros

body
ContainerRequest

Representa el cuerpo del contenedor.

options
RequestOptions

Use para establecer opciones como el tamaño de página de respuesta, los tokens de continuación, etc.

Devoluciones

Promise<ContainerResponse>

createIfNotExists(ContainerRequest, RequestOptions)

Comprueba si existe un contenedor y, si no lo hace, lo crea. Esto hará que una operación de lectura se base en el identificador de body, si no se encuentra, una operación de creación. Debe confirmar que la salida coincide con el cuerpo que pasó para las propiedades no predeterminadas (es decir, la directiva de indexación/etc.).

Un contenedor es un contenedor lógico con nombre para los elementos.

Una base de datos puede contener cero o más contenedores con nombre y cada contenedor consta de cero o más elementos JSON.

Sin esquemas, los elementos de un contenedor no necesitan compartir la misma estructura o campos.

Dado que los contenedores son recursos de aplicación, se pueden autorizar mediante la clave maestra o las claves de recursos.

function createIfNotExists(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>

Parámetros

body
ContainerRequest

Representa el cuerpo del contenedor.

options
RequestOptions

Use para establecer opciones como el tamaño de página de respuesta, los tokens de continuación, etc.

Devoluciones

Promise<ContainerResponse>

query(SqlQuerySpec, FeedOptions)

Consulta todos los contenedores.

Ejemplo

Lee todos los contenedores en la matriz. * typescript * 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(); * 

function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

Parámetros

query
SqlQuerySpec

Consulta de la configuración de la operación. Consulte SqlQuerySpec para obtener más información sobre cómo configurar una consulta.

options
FeedOptions

Use para establecer opciones como el tamaño de página de respuesta, los tokens de continuación, etc.

Devoluciones

QueryIterator<any>

QueryIterator Permite devolver contenedores específicos en una matriz o iterar por ellos de uno en uno. *

query<T>(SqlQuerySpec, FeedOptions)

Consulta todos los contenedores.

Ejemplo

Lee todos los contenedores en la matriz. * typescript * 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(); * 

function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

Parámetros

query
SqlQuerySpec

Consulta de la configuración de la operación. Consulte SqlQuerySpec para obtener más información sobre cómo configurar una consulta.

options
FeedOptions

Use para establecer opciones como el tamaño de página de respuesta, los tokens de continuación, etc.

Devoluciones

QueryIterator<T>

QueryIterator Permite devolver contenedores específicos en una matriz o iterar por ellos de uno en uno. *

readAll(FeedOptions)

Lee todos los contenedores.

Ejemplo

Lee todos los contenedores en la matriz. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); * 

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

Parámetros

options
FeedOptions

Use para establecer opciones como el tamaño de página de respuesta, los tokens de continuación, etc.

Devoluciones

QueryIterator<ContainerDefinition & Resource>

QueryIterator Permite devolver todos los contenedores de una matriz o iterarlos de uno en uno. *