CosmosClient class
Azure Cosmos DB 데이터베이스 계정의 클라이언트 쪽 논리적 표현을 제공합니다. 이 클라이언트는 Azure Cosmos DB 데이터베이스 서비스에서 요청을 구성하고 실행하는 데 사용됩니다.
예제
클라이언트 인스턴스화 및 새 데이터베이스 만들기
const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"});
await client.databases.create({id: "<database name here>"});
예제
사용자 지정 연결 정책을 사용하여 클라이언트 인스턴스화
const client = new CosmosClient({
endpoint: "<URL HERE>",
key: "<KEY HERE>",
connectionPolicy: {
requestTimeout: 10000,
},
});
생성자
| Cosmos |
새 CosmosClient 개체를 만듭니다. 사용할 수 있는 옵션에 대한 자세한 내용은 CosmosClientOptions 를 참조하세요. |
| Cosmos |
연결 문자열 새 CosmosClient 개체를 만듭니다. 데이터베이스 연결 문자열 Azure Portal에서 찾을 수 있습니다. |
속성
| databases | 새 데이터베이스를 만들거나 모든 데이터베이스를 쿼리/읽는 데 사용됩니다. 를 사용하여 예제 새 데이터베이스 만들기 |
| offers | 모든 제품을 읽는 & 쿼리하는 데 사용됩니다. 를 사용하여 |
메서드
| database(string) | ID로 기존 데이터베이스를 읽거나 업데이트하거나 삭제하거나 해당 데이터베이스에 속한 컨테이너에 액세스하는 데 사용됩니다. 이렇게 하면 네트워크 호출이 수행되지 않습니다. Database 개체를 얻은 후 를 사용하여 예제 기존 데이터베이스에서 새 컨테이너 만들기 예제 기존 데이터베이스 삭제 |
| dispose() | 백그라운드 엔드포인트 새로 고침을 지웁니다. 다른 프로세스 내에서 CosmosClient를 삭제할 때 client.dispose()를 사용합니다. |
| get |
현재 DatabaseAccount (지원되는 지역 등)에 대한 정보를 가져옵니다. |
| get |
현재 사용되는 읽기 엔드포인트를 가져옵니다. 문제 해결에 유용합니다. 위치별 엔드포인트를 사용하는 경우 URL에 지역 접미사(예: "-eastus")가 포함될 수 있습니다. |
| get |
현재 사용되는 읽기 엔드포인트를 가져옵니다. 문제 해결에 유용합니다. 위치별 엔드포인트를 사용하는 경우 URL에 지역 접미사(예: "-eastus")가 포함될 수 있습니다. |
| get |
현재 사용되는 쓰기 엔드포인트 URL을 가져옵니다. 문제 해결에 유용합니다. 위치별 엔드포인트를 사용하는 경우 URL에 지역 접미사(예: "-eastus")가 포함될 수 있습니다. |
| get |
알려진 쓰기 엔드포인트를 가져옵니다. 문제 해결에 유용합니다. 위치별 엔드포인트를 사용하는 경우 URL에는 지역 접미사(예: "-eastus")가 포함될 수 있습니다. |
| offer(string) | ID로 기존 제품을 읽거나 업데이트하는 데 사용됩니다. |
생성자 세부 정보
CosmosClient(CosmosClientOptions)
새 CosmosClient 개체를 만듭니다. 사용할 수 있는 옵션에 대한 자세한 내용은 CosmosClientOptions 를 참조하세요.
new CosmosClient(options: CosmosClientOptions)매개 변수
- options
- CosmosClientOptions
옵션 모음; 구성하려면 최소한 엔드포인트 및 인증이 필요합니다.
CosmosClient(string)
연결 문자열 새 CosmosClient 개체를 만듭니다. 데이터베이스 연결 문자열 Azure Portal에서 찾을 수 있습니다.
new CosmosClient(connectionString: string)매개 변수
- connectionString
-
string
속성 세부 정보
databases
새 데이터베이스를 만들거나 모든 데이터베이스를 쿼리/읽는 데 사용됩니다.
를 사용하여 .database(id) ID별로 특정 기존 데이터베이스를 읽거나 바꾸거나 삭제합니다.
예제
새 데이터베이스 만들기
const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
databases: Databases속성 값
offers
메서드 세부 정보
database(string)
ID로 기존 데이터베이스를 읽거나 업데이트하거나 삭제하거나 해당 데이터베이스에 속한 컨테이너에 액세스하는 데 사용됩니다.
이렇게 하면 네트워크 호출이 수행되지 않습니다. Database 개체를 얻은 후 를 사용하여 .read 데이터베이스에 대한 정보를 가져옵니다.
예제
기존 데이터베이스에서 새 컨테이너 만들기
const container = client.database("<database id>").containers.create("<container id>");
예제
기존 데이터베이스 삭제
await client.database("<id here>").delete();
function database(id: string): Database매개 변수
- id
-
string
데이터베이스의 ID입니다.
반환
dispose()
백그라운드 엔드포인트 새로 고침을 지웁니다. 다른 프로세스 내에서 CosmosClient를 삭제할 때 client.dispose()를 사용합니다.
function dispose()
getDatabaseAccount(RequestOptions)
현재 DatabaseAccount (지원되는 지역 등)에 대한 정보를 가져옵니다.
function getDatabaseAccount(options?: RequestOptions): Promise<ResourceResponse<DatabaseAccount>>매개 변수
- options
- RequestOptions
반환
Promise<ResourceResponse<DatabaseAccount>>
getReadEndpoint()
현재 사용되는 읽기 엔드포인트를 가져옵니다. 문제 해결에 유용합니다.
위치별 엔드포인트를 사용하는 경우 URL에 지역 접미사(예: "-eastus")가 포함될 수 있습니다.
function getReadEndpoint(): Promise<string>반환
Promise<string>
getReadEndpoints()
현재 사용되는 읽기 엔드포인트를 가져옵니다. 문제 해결에 유용합니다.
위치별 엔드포인트를 사용하는 경우 URL에 지역 접미사(예: "-eastus")가 포함될 수 있습니다.
function getReadEndpoints(): Promise<readonly string[]>반환
Promise<readonly string[]>
getWriteEndpoint()
현재 사용되는 쓰기 엔드포인트 URL을 가져옵니다. 문제 해결에 유용합니다.
위치별 엔드포인트를 사용하는 경우 URL에 지역 접미사(예: "-eastus")가 포함될 수 있습니다.
function getWriteEndpoint(): Promise<string>반환
Promise<string>
getWriteEndpoints()
알려진 쓰기 엔드포인트를 가져옵니다. 문제 해결에 유용합니다.
위치별 엔드포인트를 사용하는 경우 URL에는 지역 접미사(예: "-eastus")가 포함될 수 있습니다.
function getWriteEndpoints(): Promise<readonly string[]>반환
Promise<readonly string[]>
offer(string)
ID로 기존 제품을 읽거나 업데이트하는 데 사용됩니다.
function offer(id: string): Offer매개 변수
- id
-
string
제품의 ID입니다.