Database class

패키지:

@azure/cosmos

기존 데이터베이스를 읽거나 삭제하기 위한 작업입니다.

새 데이터베이스를 만들고 모든 데이터베이스를 읽고 쿼리하려면 데이터베이스 참조하세요. client.databases사용합니다.

참고: 이러한 모든 작업은 고정 예산에 대해 호출합니다. 이러한 호출이 애플리케이션을 사용하여 하위 선형으로 확장되도록 시스템을 디자인해야 합니다. 예를 들어 데이터베이스가 있는지 확인하기 위해 모든 단일 item.read() 호출하기 전에 database.read() 호출하지 마세요. 애플리케이션 시작 시 이 작업을 한 번 수행합니다.

생성자

Database(CosmosClient, string, ClientContext)

새 Database 인스턴스를 반환합니다. 참고: 이 개체를 직접 인스턴스화하지 않고 client.database(id)통해 CosmosClient 가져옵니다.

속성

client
containers	새 컨테이너를 만들거나 모든 컨테이너를 쿼리/읽는 데 사용됩니다. .database(id) 사용하여 ID별로 특정 기존 데이터베이스 읽거나 바꾸거나 삭제할 수 있습니다. 예제 새 컨테이너 만들기 const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
id
url	리소스에 대한 참조 URL을 반환합니다. 사용 권한에서 연결에 사용됩니다.
users	새 사용자를 만들거나 모든 사용자를 쿼리/읽는 데 사용됩니다. .user(id) 사용하여 ID별로 특정 기존 사용자 읽거나 바꾸거나 삭제합니다.

메서드

container(string)	ID별로 특정 기존 데이터베이스 읽거나 바꾸거나 삭제하는 데 사용됩니다. 새 컨테이너를 만들거나 모든 컨테이너를 쿼리/읽는 .containers 사용합니다. 예제 컨테이너 삭제 await client.database("<db id>").container("<container id>").delete();
delete(RequestOptions)	지정된 데이터베이스를 삭제합니다.
read(RequestOptions)	지정된 데이터베이스의 정의를 읽습니다.
readOffer(RequestOptions)	데이터베이스에 대한 제안을 가져옵니다. 없는 경우 정의되지 않은 OfferResponse를 반환합니다.
user(string)	ID별로 특정 기존 사용자 읽거나 바꾸거나 삭제하는 데 사용됩니다. .users 사용하여 새 사용자를 만들거나 모든 사용자를 쿼리/읽습니다.

생성자 세부 정보

Database(CosmosClient, string, ClientContext)

새 Database 인스턴스를 반환합니다.

참고: 이 개체를 직접 인스턴스화하지 않고 client.database(id)통해 CosmosClient 가져옵니다.

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

매개 변수

client

CosmosClient

id

string

clientContext

ClientContext

속성 세부 정보

client

client: CosmosClient

속성 값

CosmosClient

containers

새 컨테이너를 만들거나 모든 컨테이너를 쿼리/읽는 데 사용됩니다.

.database(id) 사용하여 ID별로 특정 기존 데이터베이스 읽거나 바꾸거나 삭제할 수 있습니다.

예제

새 컨테이너 만들기

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

containers: Containers

속성 값

Containers

id

id: string

속성 값

string

url

리소스에 대한 참조 URL을 반환합니다. 사용 권한에서 연결에 사용됩니다.

string url

속성 값

string

users

새 사용자를 만들거나 모든 사용자를 쿼리/읽는 데 사용됩니다.

.user(id) 사용하여 ID별로 특정 기존 사용자 읽거나 바꾸거나 삭제합니다.

users: Users

속성 값

Users

메서드 세부 정보

container(string)

ID별로 특정 기존 데이터베이스 읽거나 바꾸거나 삭제하는 데 사용됩니다.

새 컨테이너를 만들거나 모든 컨테이너를 쿼리/읽는 .containers 사용합니다.

예제

컨테이너 삭제

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

function container(id: string): Container

매개 변수

id

string

반환

Container

delete(RequestOptions)

지정된 데이터베이스를 삭제합니다.

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

매개 변수

options

RequestOptions

반환

Promise<DatabaseResponse>

read(RequestOptions)

지정된 데이터베이스의 정의를 읽습니다.

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

매개 변수

options

RequestOptions

반환

Promise<DatabaseResponse>

readOffer(RequestOptions)

데이터베이스에 대한 제안을 가져옵니다. 없는 경우 정의되지 않은 OfferResponse를 반환합니다.

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

매개 변수

options

RequestOptions

반환

Promise<OfferResponse>

user(string)

ID별로 특정 기존 사용자 읽거나 바꾸거나 삭제하는 데 사용됩니다.

.users 사용하여 새 사용자를 만들거나 모든 사용자를 쿼리/읽습니다.

function user(id: string): User

매개 변수

id

string

반환

User