Containers class
새 컨테이너를 만들고 모든 컨테이너를 읽고 쿼리하는 작업
기존 컨테이너 를 읽거나 바꾸거나 삭제하려면 컨테이너를 참조하세요. 를 사용합니다 .container(id).
참고: 이러한 모든 작업은 고정된 예산에 대해 호출합니다.
이러한 호출이 애플리케이션을 사용하여 하위 선형으로 확장되도록 시스템을 디자인해야 합니다.
예를 들어 컨테이너가 있는지 확인하기 위해 모든 단일 item.read() 호출 전에 를 호출 containers.readAll() 하지 마세요. 애플리케이션 시작 시 한 번 수행합니다.
생성자
| Containers(Database, Client |
속성
| database |
메서드
| create(Container |
컨테이너를 만듭니다. 컨테이너는 항목에 대한 명명된 논리 컨테이너입니다. 데이터베이스에는 0개 이상의 명명된 컨테이너가 포함될 수 있으며 각 컨테이너는 0개 이상의 JSON 항목으로 구성됩니다. 스키마가 없으므로 컨테이너의 항목은 동일한 구조 또는 필드를 공유할 필요가 없습니다. 컨테이너는 애플리케이션 리소스이므로 마스터 키 또는 리소스 키를 사용하여 권한을 부여할 수 있습니다. |
| create |
컨테이너가 있는지 확인하고, 컨테이너가 없는 경우 컨테이너를 만듭니다.
이렇게 하면 의 ID 컨테이너는 항목에 대한 명명된 논리 컨테이너입니다. 데이터베이스에는 0개 이상의 명명된 컨테이너가 포함될 수 있으며 각 컨테이너는 0개 이상의 JSON 항목으로 구성됩니다. 스키마가 없으므로 컨테이너의 항목은 동일한 구조 또는 필드를 공유할 필요가 없습니다. 컨테이너는 애플리케이션 리소스이므로 마스터 키 또는 리소스 키를 사용하여 권한을 부여할 수 있습니다. |
| query(Sql |
모든 컨테이너를 쿼리합니다. 예제 배열에 대한 모든 컨테이너를 읽습니다.
* |
| query<T>(Sql |
모든 컨테이너를 쿼리합니다. 예제 배열에 대한 모든 컨테이너를 읽습니다.
* |
| read |
모든 컨테이너를 읽습니다. 예제 배열에 대한 모든 컨테이너를 읽습니다.
* |
생성자 세부 정보
Containers(Database, ClientContext)
new Containers(database: Database, clientContext: ClientContext)매개 변수
- database
- Database
- clientContext
-
ClientContext
속성 세부 정보
database
메서드 세부 정보
create(ContainerRequest, RequestOptions)
컨테이너를 만듭니다.
컨테이너는 항목에 대한 명명된 논리 컨테이너입니다.
데이터베이스에는 0개 이상의 명명된 컨테이너가 포함될 수 있으며 각 컨테이너는 0개 이상의 JSON 항목으로 구성됩니다.
스키마가 없으므로 컨테이너의 항목은 동일한 구조 또는 필드를 공유할 필요가 없습니다.
컨테이너는 애플리케이션 리소스이므로 마스터 키 또는 리소스 키를 사용하여 권한을 부여할 수 있습니다.
function create(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>매개 변수
- body
- ContainerRequest
컨테이너의 본문을 나타냅니다.
- options
- RequestOptions
를 사용하여 응답 페이지 크기, 연속 토큰 등과 같은 옵션을 설정합니다.
반환
Promise<ContainerResponse>
createIfNotExists(ContainerRequest, RequestOptions)
컨테이너가 있는지 확인하고, 컨테이너가 없는 경우 컨테이너를 만듭니다.
이렇게 하면 의 ID body를 기반으로 읽기 작업이 수행되고, 없으면 만들기 작업이 수행됩니다.
출력이 기본이 아닌 속성(예: 인덱싱 정책/등)에 대해 전달한 본문과 일치하는지 확인해야 합니다.
컨테이너는 항목에 대한 명명된 논리 컨테이너입니다.
데이터베이스에는 0개 이상의 명명된 컨테이너가 포함될 수 있으며 각 컨테이너는 0개 이상의 JSON 항목으로 구성됩니다.
스키마가 없으므로 컨테이너의 항목은 동일한 구조 또는 필드를 공유할 필요가 없습니다.
컨테이너는 애플리케이션 리소스이므로 마스터 키 또는 리소스 키를 사용하여 권한을 부여할 수 있습니다.
function createIfNotExists(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>매개 변수
- body
- ContainerRequest
컨테이너의 본문을 나타냅니다.
- options
- RequestOptions
를 사용하여 응답 페이지 크기, 연속 토큰 등과 같은 옵션을 설정합니다.
반환
Promise<ContainerResponse>
query(SqlQuerySpec, FeedOptions)
모든 컨테이너를 쿼리합니다.
예제
배열에 대한 모든 컨테이너를 읽습니다.
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *
function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>매개 변수
- query
- SqlQuerySpec
작업에 대한 쿼리 구성입니다. 쿼리를 구성하는 방법에 대한 자세한 내용은 SqlQuerySpec 을 참조하세요.
- options
- FeedOptions
를 사용하여 응답 페이지 크기, 연속 토큰 등과 같은 옵션을 설정합니다.
반환
QueryIterator<any>
QueryIterator 배열에서 특정 컨테이너를 반환하거나 한 번에 하나씩 반복할 수 있습니다. *
query<T>(SqlQuerySpec, FeedOptions)
모든 컨테이너를 쿼리합니다.
예제
배열에 대한 모든 컨테이너를 읽습니다.
* typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *
function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>매개 변수
- query
- SqlQuerySpec
작업에 대한 쿼리 구성입니다. 쿼리를 구성하는 방법에 대한 자세한 내용은 SqlQuerySpec 을 참조하세요.
- options
- FeedOptions
를 사용하여 응답 페이지 크기, 연속 토큰 등과 같은 옵션을 설정합니다.
반환
QueryIterator 배열에서 특정 컨테이너를 반환하거나 한 번에 하나씩 반복할 수 있습니다. *
readAll(FeedOptions)
모든 컨테이너를 읽습니다.
예제
배열에 대한 모든 컨테이너를 읽습니다.
* typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *
function readAll(options?: FeedOptions): QueryIterator<ContainerDefinition & Resource>매개 변수
- options
- FeedOptions
를 사용하여 응답 페이지 크기, 연속 토큰 등과 같은 옵션을 설정합니다.
반환
QueryIterator 배열의 모든 컨테이너를 반환하거나 한 번에 하나씩 반복할 수 있습니다. *