Databases class
Operaciones para crear nuevas bases de datos y leer o consultar todas las bases de datos
Consulte Base de datos para leer o eliminar una base de datos existente; use client.database(id)
.
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 databases.readAll()
antes de cada llamada única item.read()
para asegurarse de que la base de datos existe; hála una vez en el inicio de la aplicación.
Propiedades
client |
Métodos
create(Database |
Envíe una solicitud para crear una base de datos. Una base de datos administra usuarios, permisos y un conjunto de contenedores. Cada cuenta de base de datos de Azure Cosmos DB es capaz de admitir varias bases de datos con nombre independientes, y la base de datos es el contenedor lógico de los datos. Cada base de datos consta de uno o varios contenedores, cada uno de los cuales, a su vez, contiene uno o varios documentos. Dado que las bases de datos son un recurso administrativo, la clave maestra de servicio será necesaria para acceder y completar correctamente cualquier acción mediante las API de usuario. |
create |
Compruebe si existe una base de datos y, si no es así, créela.
Esto hará que una operación de lectura se base en el identificador de Una base de datos administra usuarios, permisos y un conjunto de contenedores. Cada cuenta de base de datos de Azure Cosmos DB es capaz de admitir varias bases de datos con nombre independientes, y la base de datos es el contenedor lógico de los datos. Cada base de datos consta de uno o varios contenedores, cada uno de los cuales, a su vez, contiene uno o varios documentos. Dado que las bases de datos son un recurso administrativo, la clave maestra de servicio será necesaria para acceder y completar correctamente cualquier acción mediante las API de usuario. |
query(string | Sql |
Consulta todas las bases de datos. Ejemplo Lea todas las bases de datos en la matriz.
* |
query<T>(string | Sql |
Consulta todas las bases de datos. Ejemplo Lea todas las bases de datos en la matriz.
* |
read |
Lee todas las bases de datos. Ejemplo Lea todas las bases de datos en la matriz.
* |
Detalles de las propiedades
client
Detalles del método
create(DatabaseRequest, RequestOptions)
Envíe una solicitud para crear una base de datos.
Una base de datos administra usuarios, permisos y un conjunto de contenedores. Cada cuenta de base de datos de Azure Cosmos DB es capaz de admitir varias bases de datos con nombre independientes, y la base de datos es el contenedor lógico de los datos.
Cada base de datos consta de uno o varios contenedores, cada uno de los cuales, a su vez, contiene uno o varios documentos. Dado que las bases de datos son un recurso administrativo, la clave maestra de servicio será necesaria para acceder y completar correctamente cualquier acción mediante las API de usuario.
function create(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>
Parámetros
- body
- DatabaseRequest
DatabaseDefinition que representa la base de datos que se va a crear.
- options
- RequestOptions
Use para establecer opciones como el tamaño de página de respuesta, los tokens de continuación, etc.
Devoluciones
Promise<DatabaseResponse>
createIfNotExists(DatabaseRequest, RequestOptions)
Compruebe si existe una base de datos y, si no es así, créela.
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.
Una base de datos administra usuarios, permisos y un conjunto de contenedores. Cada cuenta de base de datos de Azure Cosmos DB es capaz de admitir varias bases de datos con nombre independientes, y la base de datos es el contenedor lógico de los datos.
Cada base de datos consta de uno o varios contenedores, cada uno de los cuales, a su vez, contiene uno o varios documentos. Dado que las bases de datos son un recurso administrativo, la clave maestra de servicio será necesaria para acceder y completar correctamente cualquier acción mediante las API de usuario.
function createIfNotExists(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>
Parámetros
- body
- DatabaseRequest
DatabaseDefinition que representa la base de datos que se va a crear.
- options
- RequestOptions
Opciones adicionales para la solicitud
Devoluciones
Promise<DatabaseResponse>
query(string | SqlQuerySpec, FeedOptions)
Consulta todas las bases de datos.
Ejemplo
Lea todas las bases de datos en la matriz.
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *
function query(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<any>
Parámetros
- query
-
string | 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 todas las bases de datos de una matriz o iterar por ellas de una en una. *
query<T>(string | SqlQuerySpec, FeedOptions)
Consulta todas las bases de datos.
Ejemplo
Lea todas las bases de datos en la matriz.
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *
function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>
Parámetros
- query
-
string | 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 Permite devolver todas las bases de datos de una matriz o iterar por ellas de una en una. *
readAll(FeedOptions)
Lee todas las bases de datos.
Ejemplo
Lea todas las bases de datos en la matriz.
* typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *
function readAll(options?: FeedOptions): QueryIterator<DatabaseDefinition & 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 Permite devolver todas las bases de datos de una matriz o iterar por ellas de una en una. *