Delen via

Database class

  • Referentie
Pakket:
@azure/cosmos

Bewerkingen voor het lezen of verwijderen van een bestaande database.

Zie Databases voor het maken van nieuwe databases en het lezen/opvragen van alle databases; client.databasesgebruiken.

Opmerking: al deze bewerkingen voeren aanroepen tegen een vast budget. U moet uw systeem zodanig ontwerpen dat deze aanroepen sublijnig worden geschaald met uw toepassing. Roep bijvoorbeeld niet database.read() aan vóór elke item.read() aanroep om ervoor te zorgen dat de database bestaat; Doe dit eenmaal bij het opstarten van de toepassing.

Constructors

Database(CosmosClient, string, ClientContext)

Retourneert een nieuw Database-exemplaar.

Opmerking: het is de bedoeling om dit object te verkrijgen van CosmosClient- via client.database(id), niet om het zelf te instantiëren.

Eigenschappen

client
containers

Wordt gebruikt voor het maken van nieuwe containers of het opvragen/lezen van alle containers.

Gebruik .database(id) om een specifieke, bestaande database op id te lezen, te vervangen of te verwijderen.

voorbeeld van

Een nieuwe container maken

const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
id
url

Retourneert een referentie-URL naar de resource. Wordt gebruikt voor het koppelen in machtigingen.
users

Wordt gebruikt voor het maken van nieuwe gebruikers of het opvragen/lezen van alle gebruikers.

Gebruik .user(id) om een specifieke, bestaande gebruiker op id te lezen, te vervangen of te verwijderen.

Methoden

container(string)

Wordt gebruikt voor het lezen, vervangen of verwijderen van een specifieke, bestaande Database op id.

Gebruik .containers het maken van nieuwe containers of het opvragen/lezen van alle containers.

voorbeeld van

Een container verwijderen

await client.database("<db id>").container("<container id>").delete();
delete(RequestOptions)

Verwijder de opgegeven database.
read(RequestOptions)

Lees de definitie van de opgegeven database.
readOffer(RequestOptions)

Hiermee krijgt u een aanbieding voor de database. Als er geen bestaat, wordt een OfferResponse geretourneerd met niet-gedefinieerd.
user(string)

Wordt gebruikt voor het lezen, vervangen of verwijderen van een specifieke, bestaande gebruiker op id.

Gebruik .users voor het maken van nieuwe gebruikers of het opvragen/lezen van alle gebruikers.

Constructordetails

Database(CosmosClient, string, ClientContext)

Retourneert een nieuw Database-exemplaar.

Opmerking: het is de bedoeling om dit object te verkrijgen van CosmosClient- via client.database(id), niet om het zelf te instantiëren.

new Database(client: CosmosClient, id: string, clientContext: ClientContext)

Parameters

client
CosmosClient
id

string

clientContext

ClientContext

Eigenschapdetails

client 

client: CosmosClient

Waarde van eigenschap

CosmosClient

containers

Wordt gebruikt voor het maken van nieuwe containers of het opvragen/lezen van alle containers.

Gebruik .database(id) om een specifieke, bestaande database op id te lezen, te vervangen of te verwijderen.

voorbeeld van

Een nieuwe container maken

const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});

containers: Containers

Waarde van eigenschap

Containers

id 

id: string

Waarde van eigenschap

string

url

Retourneert een referentie-URL naar de resource. Wordt gebruikt voor het koppelen in machtigingen.

string url

Waarde van eigenschap

string

users

Wordt gebruikt voor het maken van nieuwe gebruikers of het opvragen/lezen van alle gebruikers.

Gebruik .user(id) om een specifieke, bestaande gebruiker op id te lezen, te vervangen of te verwijderen.

users: Users

Waarde van eigenschap

Users

Methodedetails

container(string)

Wordt gebruikt voor het lezen, vervangen of verwijderen van een specifieke, bestaande Database op id.

Gebruik .containers het maken van nieuwe containers of het opvragen/lezen van alle containers.

voorbeeld van

Een container verwijderen

await client.database("<db id>").container("<container id>").delete();

function container(id: string): Container

Parameters

id

string

Retouren

Container

delete(RequestOptions)

Verwijder de opgegeven database.

function delete(options?: RequestOptions): Promise<DatabaseResponse>

Parameters

options
RequestOptions

Retouren

Promise<DatabaseResponse>

read(RequestOptions)

Lees de definitie van de opgegeven database.

function read(options?: RequestOptions): Promise<DatabaseResponse>

Parameters

options
RequestOptions

Retouren

Promise<DatabaseResponse>

readOffer(RequestOptions)

Hiermee krijgt u een aanbieding voor de database. Als er geen bestaat, wordt een OfferResponse geretourneerd met niet-gedefinieerd.

function readOffer(options?: RequestOptions): Promise<OfferResponse>

Parameters

options
RequestOptions

Retouren

Promise<OfferResponse>

user(string)

Wordt gebruikt voor het lezen, vervangen of verwijderen van een specifieke, bestaande gebruiker op id.

Gebruik .users voor het maken van nieuwe gebruikers of het opvragen/lezen van alle gebruikers.

function user(id: string): User

Parameters

id

string

Retouren

User