Containers class
Operações para criar novos contêineres e ler/consultar todos os contêineres
Consulte Contêiner para ler, substituir ou excluir um contêiner existente; use .container(id).
Observação: todas essas operações fazem chamadas contra um orçamento fixo.
Você deve projetar seu sistema de modo que essas chamadas sejam dimensionadas de forma sublinear com seu aplicativo.
Por exemplo, não chame containers.readAll() antes de cada item.read() chamada, para garantir que o contêiner exista; faça isso uma vez na inicialização do aplicativo.
Construtores
| Containers(Database, Client |
Propriedades
| database |
Métodos
| create(Container |
Cria um contêiner. Um contêiner é um contêiner lógico nomeado para itens. Um banco de dados pode conter zero ou mais contêineres nomeados e cada contêiner consiste em zero ou mais itens JSON. Sem esquema, os itens em um contêiner não precisam compartilhar a mesma estrutura ou campos. Como os contêineres são recursos de aplicativo, eles podem ser autorizados usando a chave mestra ou as chaves de recurso. |
| create |
Verifica se existe um contêiner e, se não existir, cria-o.
Isso fará com que uma operação de leitura com base na ID no Um contêiner é um contêiner lógico nomeado para itens. Um banco de dados pode conter zero ou mais contêineres nomeados e cada contêiner consiste em zero ou mais itens JSON. Sem esquema, os itens em um contêiner não precisam compartilhar a mesma estrutura ou campos. Como os contêineres são recursos de aplicativo, eles podem ser autorizados usando a chave mestra ou as chaves de recurso. |
| query(Sql |
Consulta todos os contêineres. Exemplo Ler todos os contêineres na matriz.
* |
| query<T>(Sql |
Consulta todos os contêineres. Exemplo Ler todos os contêineres na matriz.
* |
| read |
Ler todos os contêineres. Exemplo Ler todos os contêineres na matriz.
* |
Detalhes do construtor
Containers(Database, ClientContext)
new Containers(database: Database, clientContext: ClientContext)Parâmetros
- database
- Database
- clientContext
-
ClientContext
Detalhes da propriedade
database
Detalhes do método
create(ContainerRequest, RequestOptions)
Cria um contêiner.
Um contêiner é um contêiner lógico nomeado para itens.
Um banco de dados pode conter zero ou mais contêineres nomeados e cada contêiner consiste em zero ou mais itens JSON.
Sem esquema, os itens em um contêiner não precisam compartilhar a mesma estrutura ou campos.
Como os contêineres são recursos de aplicativo, eles podem ser autorizados usando a chave mestra ou as chaves de recurso.
function create(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>Parâmetros
- body
- ContainerRequest
Representa o corpo do contêiner.
- options
- RequestOptions
Use para definir opções como tamanho da página de resposta, tokens de continuação etc.
Retornos
Promise<ContainerResponse>
createIfNotExists(ContainerRequest, RequestOptions)
Verifica se existe um contêiner e, se não existir, cria-o.
Isso fará com que uma operação de leitura com base na ID no body, se não for encontrada, uma operação de criação.
Você deve confirmar se a saída corresponde ao corpo passado para propriedades não padrão (ou seja, política de indexação/etc.)
Um contêiner é um contêiner lógico nomeado para itens.
Um banco de dados pode conter zero ou mais contêineres nomeados e cada contêiner consiste em zero ou mais itens JSON.
Sem esquema, os itens em um contêiner não precisam compartilhar a mesma estrutura ou campos.
Como os contêineres são recursos de aplicativo, eles podem ser autorizados usando a chave mestra ou as chaves de recurso.
function createIfNotExists(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>Parâmetros
- body
- ContainerRequest
Representa o corpo do contêiner.
- options
- RequestOptions
Use para definir opções como tamanho da página de resposta, tokens de continuação etc.
Retornos
Promise<ContainerResponse>
query(SqlQuerySpec, FeedOptions)
Consulta todos os contêineres.
Exemplo
Ler todos os contêineres na 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
Configuração de consulta para a operação. Consulte SqlQuerySpec para obter mais informações sobre como configurar uma consulta.
- options
- FeedOptions
Use para definir opções como tamanho da página de resposta, tokens de continuação etc.
Retornos
QueryIterator<any>
QueryIterator Permite que você retorne contêineres específicos em uma matriz ou itere sobre eles um de cada vez. *
query<T>(SqlQuerySpec, FeedOptions)
Consulta todos os contêineres.
Exemplo
Ler todos os contêineres na 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
Configuração de consulta para a operação. Consulte SqlQuerySpec para obter mais informações sobre como configurar uma consulta.
- options
- FeedOptions
Use para definir opções como tamanho da página de resposta, tokens de continuação etc.
Retornos
QueryIterator Permite que você retorne contêineres específicos em uma matriz ou itere sobre eles um de cada vez. *
readAll(FeedOptions)
Ler todos os contêineres.
Exemplo
Ler todos os contêineres na 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 definir opções como tamanho da página de resposta, tokens de continuação etc.
Retornos
QueryIterator Permite que você retorne todos os contêineres em uma matriz ou itere sobre eles um de cada vez. *