Container class
Operaciones para leer, reemplazar o eliminar un contenedor específico existente por identificador.
Consulte contenedores para crear nuevos contenedores y leer y consultar todos los contenedores; use .containers
.
Nota: todas estas operaciones realizan llamadas con un presupuesto fijo.
Debe diseñar el sistema de forma que estas llamadas se escalen de forma sublineal con la aplicación.
Por ejemplo, no llame a container(id).read()
antes de cada llamada item.read()
única, para asegurarse de que el contenedor existe; Haga esto una vez en el inicio de la aplicación.
Propiedades
conflicts | Operaciones para leer y consultar conflictos para el contenedor especificado. Para leer o eliminar un conflicto específico, use |
database | |
id | |
items | Operaciones para crear nuevos elementos y leer o consultar todos los elementos Para leer, reemplazar o eliminar un elemento existente, use de ejemplo de Crear un nuevo elemento
|
scripts | Todas las operaciones para procedimientos almacenados, desencadenadores y funciones definidas por el usuario |
url | Devuelve una dirección URL de referencia al recurso. Se usa para vincular en Permisos. |
Métodos
conflict(string, Partition |
Se usa para leer, reemplazar o eliminar un conflicto específico existente por identificador. Use |
delete(Request |
Eliminación del contenedor |
delete |
Eliminar todos los documentos pertenecen al contenedor para el valor de clave de partición proporcionado |
get |
|
get |
Obtiene primero la definición de clave de partición examinando la memoria caché; de lo contrario, lee la colección. |
get |
|
item(string, Partition |
Se usa para leer, reemplazar o eliminar un elemento de específico existente por identificador. Use de ejemplo de Reemplazar un |
read(Request |
Leer la definición del contenedor |
read |
Obtiene la oferta en el contenedor. Si no existe ninguno, devuelve una offerResponse con undefined. |
read |
|
replace(Container |
Reemplazar la definición del contenedor |
Detalles de las propiedades
conflicts
Operaciones para leer y consultar conflictos para el contenedor especificado.
Para leer o eliminar un conflicto específico, use .conflict(id)
.
Conflicts conflicts
Valor de propiedad
database
id
id: string
Valor de propiedad
string
items
Operaciones para crear nuevos elementos y leer o consultar todos los elementos
Para leer, reemplazar o eliminar un elemento existente, use .item(id)
.
de ejemplo de
Crear un nuevo elemento
const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
Items items
Valor de propiedad
scripts
Todas las operaciones para procedimientos almacenados, desencadenadores y funciones definidas por el usuario
Scripts scripts
Valor de propiedad
url
Devuelve una dirección URL de referencia al recurso. Se usa para vincular en Permisos.
string url
Valor de propiedad
string
Detalles del método
conflict(string, PartitionKey)
Se usa para leer, reemplazar o eliminar un conflicto específico existente por identificador.
Use .conflicts
para crear nuevos conflictos o consultar o leer todos los conflictos.
function conflict(id: string, partitionKey?: PartitionKey): Conflict
Parámetros
- id
-
string
Identificador del conflicto de.
- partitionKey
- PartitionKey
Devoluciones
delete(RequestOptions)
Eliminación del contenedor
function delete(options?: RequestOptions): Promise<ContainerResponse>
Parámetros
- options
- RequestOptions
Devoluciones
Promise<ContainerResponse>
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)
Eliminar todos los documentos pertenecen al contenedor para el valor de clave de partición proporcionado
function deleteAllItemsForPartitionKey(partitionKey: PartitionKey, options?: RequestOptions): Promise<ContainerResponse>
Parámetros
- partitionKey
- PartitionKey
Valor de clave de partición de los elementos que se van a eliminar
- options
- RequestOptions
Devoluciones
Promise<ContainerResponse>
getFeedRanges()
function getFeedRanges(): Promise<readonly FeedRange[]>
Devoluciones
Promise<readonly FeedRange[]>
todos los intervalos de fuente para los que se puede capturar el suministro de cambios.
getPartitionKeyDefinition()
Advertencia
Esta API ya está en desuso.
This method has been renamed to readPartitionKeyDefinition.
Obtiene primero la definición de clave de partición examinando la memoria caché; de lo contrario, lee la colección.
function getPartitionKeyDefinition(): Promise<ResourceResponse<PartitionKeyDefinition>>
Devoluciones
Promise<ResourceResponse<PartitionKeyDefinition>>
getQueryPlan(string | SqlQuerySpec)
function getQueryPlan(query: string | SqlQuerySpec): Promise<Response_2<PartitionedQueryExecutionInfo>>
Parámetros
- query
-
string | SqlQuerySpec
Devoluciones
Promise<Response_2<PartitionedQueryExecutionInfo>>
item(string, PartitionKey)
Se usa para leer, reemplazar o eliminar un elemento de específico existente por identificador.
Use .items
para crear nuevos elementos o consultar o leer todos los elementos.
de ejemplo de
Reemplazar un const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});
de elemento
function item(id: string, partitionKeyValue?: PartitionKey): Item
Parámetros
- partitionKeyValue
- PartitionKey
Valor de la clave de partición elemento de
Devoluciones
read(RequestOptions)
Leer la definición del contenedor
function read(options?: RequestOptions): Promise<ContainerResponse>
Parámetros
- options
- RequestOptions
Devoluciones
Promise<ContainerResponse>
readOffer(RequestOptions)
Obtiene la oferta en el contenedor. Si no existe ninguno, devuelve una offerResponse con undefined.
function readOffer(options?: RequestOptions): Promise<OfferResponse>
Parámetros
- options
- RequestOptions
Devoluciones
Promise<OfferResponse>
readPartitionKeyRanges(FeedOptions)
function readPartitionKeyRanges(feedOptions?: FeedOptions): QueryIterator<PartitionKeyRange>
Parámetros
- feedOptions
- FeedOptions
Devoluciones
QueryIterator<PartitionKeyRange>
replace(ContainerDefinition, RequestOptions)
Reemplazar la definición del contenedor
function replace(body: ContainerDefinition, options?: RequestOptions): Promise<ContainerResponse>
Parámetros
- body
- ContainerDefinition
- options
- RequestOptions
Devoluciones
Promise<ContainerResponse>