Databases class
Åtgärder för att skapa nya databaser och läsa/fråga alla databaser
Se Databas för att läsa eller ta bort en befintlig databas; använd client.database(id)
.
Obs! Alla dessa åtgärder gör anrop mot en fast budget.
Du bör utforma systemet så att dessa anrop skalas sublinearly med ditt program.
Anropa databases.readAll()
till exempel inte före varje enskilt item.read()
anrop för att säkerställa att databasen finns. Gör detta en gång när programmet startas.
Egenskaper
client |
Metoder
create(Database |
Skicka en begäran om att skapa en databas. En databas hanterar användare, behörigheter och en uppsättning containrar. Varje Azure Cosmos DB-databaskonto har stöd för flera oberoende namngivna databaser, där databasen är den logiska containern för data. Varje databas består av en eller flera containrar som var och en i sin tur innehåller ett eller flera dokument. Eftersom databaser är en administrativ resurs krävs huvudnyckeln för tjänsten för att få åtkomst till och slutföra alla åtgärder med hjälp av användar-API:erna. |
create |
Kontrollera om det finns en databas och skapa den om den inte finns.
Detta gör en läsåtgärd baserat på ID:t i En databas hanterar användare, behörigheter och en uppsättning containrar. Varje Azure Cosmos DB-databaskonto har stöd för flera oberoende namngivna databaser, där databasen är den logiska containern för data. Varje databas består av en eller flera containrar som var och en i sin tur innehåller ett eller flera dokument. Eftersom databaser är en administrativ resurs krävs huvudnyckeln för tjänsten för att få åtkomst till och slutföra alla åtgärder med hjälp av användar-API:erna. |
query(string | Sql |
Kör frågor mot alla databaser. Exempel Läs alla databaser till matrisen.
* |
query<T>(string | Sql |
Kör frågor mot alla databaser. Exempel Läs alla databaser till matrisen.
* |
read |
Läser alla databaser. Exempel Läs alla databaser till matrisen.
* |
Egenskapsinformation
client
Metodinformation
create(DatabaseRequest, RequestOptions)
Skicka en begäran om att skapa en databas.
En databas hanterar användare, behörigheter och en uppsättning containrar. Varje Azure Cosmos DB-databaskonto har stöd för flera oberoende namngivna databaser, där databasen är den logiska containern för data.
Varje databas består av en eller flera containrar som var och en i sin tur innehåller ett eller flera dokument. Eftersom databaser är en administrativ resurs krävs huvudnyckeln för tjänsten för att få åtkomst till och slutföra alla åtgärder med hjälp av användar-API:erna.
function create(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>
Parametrar
- body
- DatabaseRequest
Den DatabaseDefinition som representerar databasen som ska skapas.
- options
- RequestOptions
Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.
Returer
Promise<DatabaseResponse>
createIfNotExists(DatabaseRequest, RequestOptions)
Kontrollera om det finns en databas och skapa den om den inte finns.
Detta gör en läsåtgärd baserat på ID:t i body
, och om den inte hittas blir det en skapandeåtgärd.
En databas hanterar användare, behörigheter och en uppsättning containrar. Varje Azure Cosmos DB-databaskonto har stöd för flera oberoende namngivna databaser, där databasen är den logiska containern för data.
Varje databas består av en eller flera containrar som var och en i sin tur innehåller ett eller flera dokument. Eftersom databaser är en administrativ resurs krävs huvudnyckeln för tjänsten för att få åtkomst till och slutföra alla åtgärder med hjälp av användar-API:erna.
function createIfNotExists(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>
Parametrar
- body
- DatabaseRequest
Den DatabaseDefinition som representerar databasen som ska skapas.
- options
- RequestOptions
Ytterligare alternativ för begäran
Returer
Promise<DatabaseResponse>
query(string | SqlQuerySpec, FeedOptions)
Kör frågor mot alla databaser.
Exempel
Läs alla databaser till matrisen.
* 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>
Parametrar
- query
-
string | SqlQuerySpec
Frågekonfiguration för åtgärden. Mer information om hur du konfigurerar en fråga finns i SqlQuerySpec .
- options
- FeedOptions
Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.
Returer
QueryIterator<any>
QueryIterator Gör att du kan returnera alla databaser i en matris eller iterera över dem en i taget. *
query<T>(string | SqlQuerySpec, FeedOptions)
Kör frågor mot alla databaser.
Exempel
Läs alla databaser till matrisen.
* 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>
Parametrar
- query
-
string | SqlQuerySpec
Frågekonfiguration för åtgärden. Mer information om hur du konfigurerar en fråga finns i SqlQuerySpec .
- options
- FeedOptions
Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.
Returer
QueryIterator Gör att du kan returnera alla databaser i en matris eller iterera över dem en i taget. *
readAll(FeedOptions)
Läser alla databaser.
Exempel
Läs alla databaser till matrisen.
* typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *
function readAll(options?: FeedOptions): QueryIterator<DatabaseDefinition & Resource>
Parametrar
- options
- FeedOptions
Använd för att ange alternativ som svarssidans storlek, fortsättningstoken osv.
Returer
QueryIterator Gör att du kan returnera alla databaser i en matris eller iterera över dem en i taget. *