Containers class
Operações para criar novos contentores e leitura/consulta de todos os contentores
Veja Contentor para ler, substituir ou eliminar um contentor existente; utilize .container(id).
Nota: todas estas operações fazem chamadas relativamente a um orçamento fixo.
Deve estruturar o seu sistema de modo a que estas chamadas dimensionem sublinearmente com a sua aplicação.
Por exemplo, não chame containers.readAll() antes de cada item.read() chamada, para garantir que o contentor existe; faça-o uma vez no arranque da aplicação.
Construtores
| Containers(Database, Client |
Propriedades
| database |
Métodos
| create(Container |
Cria um contentor. Um contentor é um contentor lógico com nome para itens. Uma base de dados pode conter zero ou mais contentores nomeados e cada contentor é composto por zero ou mais itens JSON. Sem esquema, os itens num contentor não precisam de partilhar a mesma estrutura ou campos. Uma vez que os contentores são recursos da aplicação, podem ser autorizados através da chave mestra ou das chaves de recurso. |
| create |
Verifica se existe um Contentor e, se não existir, cria-o.
Esta ação fará uma operação de leitura com base no ID no Um contentor é um contentor lógico com nome para itens. Uma base de dados pode conter zero ou mais contentores nomeados e cada contentor é composto por zero ou mais itens JSON. Sem esquema, os itens num contentor não precisam de partilhar a mesma estrutura ou campos. Uma vez que os contentores são recursos da aplicação, podem ser autorizados através da chave mestra ou das chaves de recurso. |
| query(Sql |
Consulta todos os contentores. Exemplo Leia todos os contentores para matriz.
* |
| query<T>(Sql |
Consulta todos os contentores. Exemplo Leia todos os contentores para matriz.
* |
| read |
Leia todos os contentores. Exemplo Leia todos os contentores para matriz.
* |
Detalhes do Construtor
Containers(Database, ClientContext)
new Containers(database: Database, clientContext: ClientContext)Parâmetros
- database
- Database
- clientContext
-
ClientContext
Detalhes de Propriedade
database
Detalhes de Método
create(ContainerRequest, RequestOptions)
Cria um contentor.
Um contentor é um contentor lógico com nome para itens.
Uma base de dados pode conter zero ou mais contentores nomeados e cada contentor é composto por zero ou mais itens JSON.
Sem esquema, os itens num contentor não precisam de partilhar a mesma estrutura ou campos.
Uma vez que os contentores são recursos da aplicação, podem ser autorizados através da chave mestra ou das chaves de recurso.
function create(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>Parâmetros
- body
- ContainerRequest
Representa o corpo do contentor.
- options
- RequestOptions
Utilize para definir opções como o tamanho da página de resposta, tokens de continuação, etc.
Devoluções
Promise<ContainerResponse>
createIfNotExists(ContainerRequest, RequestOptions)
Verifica se existe um Contentor e, se não existir, cria-o.
Esta ação fará uma operação de leitura com base no ID no body, se não for encontrada, uma operação de criação.
Deve confirmar que o resultado corresponde ao corpo que transmitiu para propriedades não predefinidas (ou seja, política de indexação/etc.)
Um contentor é um contentor lógico com nome para itens.
Uma base de dados pode conter zero ou mais contentores nomeados e cada contentor é composto por zero ou mais itens JSON.
Sem esquema, os itens num contentor não precisam de partilhar a mesma estrutura ou campos.
Uma vez que os contentores são recursos da aplicação, podem ser autorizados através da chave mestra ou das chaves de recurso.
function createIfNotExists(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>Parâmetros
- body
- ContainerRequest
Representa o corpo do contentor.
- options
- RequestOptions
Utilize para definir opções como o tamanho da página de resposta, tokens de continuação, etc.
Devoluções
Promise<ContainerResponse>
query(SqlQuerySpec, FeedOptions)
Consulta todos os contentores.
Exemplo
Leia todos os contentores para 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
Utilize para definir opções como o tamanho da página de resposta, tokens de continuação, etc.
Devoluções
QueryIterator<any>
QueryIterator Permite-lhe devolver contentores específicos numa matriz ou iterar um de cada vez. *
query<T>(SqlQuerySpec, FeedOptions)
Consulta todos os contentores.
Exemplo
Leia todos os contentores para 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
Utilize para definir opções como o tamanho da página de resposta, tokens de continuação, etc.
Devoluções
QueryIterator Permite-lhe devolver contentores específicos numa matriz ou iterar um de cada vez. *
readAll(FeedOptions)
Leia todos os contentores.
Exemplo
Leia todos os contentores para matriz.
* typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *
function readAll(options?: FeedOptions): QueryIterator<ContainerDefinition & Resource>Parâmetros
- options
- FeedOptions
Utilize para definir opções como o tamanho da página de resposta, tokens de continuação, etc.
Devoluções
QueryIterator Permite-lhe devolver todos os contentores numa matriz ou iterar um de cada vez. *