Items class

  • 참조
패키지:
@azure/cosmos

새 항목을 만들고 모든 항목을 읽기/쿼리하기 위한 작업

기존 컨테이너를 읽거나 바꾸거나 삭제하려면 항목을 참조하세요. 를 사용합니다 .item(id).

속성

container

메서드

batch(OperationInput[], PartitionKey, RequestOptions)

항목에 대한 트랜잭션 일괄 처리 작업을 실행합니다.

Batch는 작업 수행에 따라 입력되는 작업의 배열을 사용합니다. Batch는 트랜잭션이며 실패할 경우 모든 작업을 롤백합니다. 선택 항목은 만들기, Upsert, 읽기, 바꾸기 및 삭제입니다.

사용법 예제:

// partitionKey is required as a second argument to batch, but defaults to the default partition key
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      partitionKey: 'A',
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.batch(operations)
bulk(OperationInput[], BulkOptions, RequestOptions)

항목에 대한 대량 작업을 실행합니다.

대량 작업은 작업 수행에 따라 입력되는 작업의 배열을 사용합니다. 선택 항목은 만들기, Upsert, 읽기, 바꾸기 및 삭제입니다.

사용법 예제:

// partitionKey is optional at the top level if present in the resourceBody
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      partitionKey: 'A',
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.bulk(operations)
changeFeed(ChangeFeedOptions)

변경 내용을 반복하는 을 ChangeFeedIterator 만듭니다.
changeFeed(PartitionKey, ChangeFeedOptions)

변경 내용을 반복하는 을 ChangeFeedIterator 만듭니다.

예제

변경 피드의 시작 부분에서 읽습니다.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
changeFeed<T>(ChangeFeedOptions)

변경 내용을 반복하는 을 ChangeFeedIterator 만듭니다.
changeFeed<T>(PartitionKey, ChangeFeedOptions)

변경 내용을 반복하는 을 ChangeFeedIterator 만듭니다.
create<T>(T, RequestOptions)

항목을 만듭니다.

제공된 모든 형식 T가 반드시 SDK에 의해 적용되는 것은 아닙니다. 더 많거나 적은 속성을 얻을 수 있으며 이를 적용하는 것은 논리에 달려 있습니다.

JSON 항목에 대해 설정된 스키마가 없습니다. 여기에는 사용자 지정 속성의 개수가 포함될 수 있습니다.
getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

변경 내용을 반복하는 반복기를 반환합니다. 반환된 반복기를 사용하여 단일 파티션 키, 피드 범위 또는 전체 컨테이너에 대한 변경 내용을 가져올 수 있습니다.
query(string | SqlQuerySpec, FeedOptions)

모든 항목을 쿼리합니다.

예제

배열에 대한 모든 항목을 읽습니다.

const querySpec: SqlQuerySpec = {
  query: "SELECT * FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query(querySpec).fetchAll();
query<T>(string | SqlQuerySpec, FeedOptions)

모든 항목을 쿼리합니다.

예제

배열에 대한 모든 항목을 읽습니다.

const querySpec: SqlQuerySpec = {
  query: "SELECT firstname FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query<{firstName: string}>(querySpec).fetchAll();
readAll(FeedOptions)

모든 항목을 읽습니다.

JSON 항목에 대해 설정된 스키마가 없습니다. 여기에는 사용자 지정 속성의 개수가 포함될 수 있습니다.

예제

배열에 대한 모든 항목을 읽습니다.

const {body: containerList} = await items.readAll().fetchAll();
readAll<T>(FeedOptions)

모든 항목을 읽습니다.

제공된 모든 형식 T가 반드시 SDK에 의해 적용되는 것은 아닙니다. 더 많거나 적은 속성을 얻을 수 있으며 이를 적용하는 것은 논리에 달려 있습니다.

JSON 항목에 대해 설정된 스키마가 없습니다. 여기에는 사용자 지정 속성의 개수가 포함될 수 있습니다.

예제

배열에 대한 모든 항목을 읽습니다.

const {body: containerList} = await items.readAll().fetchAll();
readChangeFeed(ChangeFeedOptions)

변경 내용을 반복하는 을 ChangeFeedIterator 만듭니다.
readChangeFeed(PartitionKey, ChangeFeedOptions)

변경 내용을 반복하는 을 ChangeFeedIterator 만듭니다.

예제

변경 피드의 시작 부분에서 읽습니다.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();
readChangeFeed<T>(ChangeFeedOptions)

변경 내용을 반복하는 을 ChangeFeedIterator 만듭니다.
readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

변경 내용을 반복하는 을 ChangeFeedIterator 만듭니다.
upsert(unknown, RequestOptions)

항목을 Upsert합니다.

JSON 항목에 대해 설정된 스키마가 없습니다. 여기에는 사용자 지정 속성의 개수가 포함될 수 있습니다.
upsert<T>(T, RequestOptions)

항목을 Upsert합니다.

제공된 모든 형식 T가 반드시 SDK에 의해 적용되는 것은 아닙니다. 더 많거나 적은 속성을 얻을 수 있으며 이를 적용하는 것은 논리에 달려 있습니다.

JSON 항목에 대해 설정된 스키마가 없습니다. 여기에는 사용자 지정 속성의 개수가 포함될 수 있습니다.

속성 세부 정보

container 

container: Container

속성 값

Container

메서드 세부 정보

batch(OperationInput[], PartitionKey, RequestOptions)

항목에 대한 트랜잭션 일괄 처리 작업을 실행합니다.

Batch는 작업 수행에 따라 입력되는 작업의 배열을 사용합니다. Batch는 트랜잭션이며 실패할 경우 모든 작업을 롤백합니다. 선택 항목은 만들기, Upsert, 읽기, 바꾸기 및 삭제입니다.

사용법 예제:

// partitionKey is required as a second argument to batch, but defaults to the default partition key
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      partitionKey: 'A',
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.batch(operations)

function batch(operations: OperationInput[], partitionKey?: PartitionKey, options?: RequestOptions): Promise<Response_2<OperationResponse[]>>

매개 변수

operations

OperationInput[]

작업 목록입니다. 제한 100

partitionKey
PartitionKey
options
RequestOptions

요청을 수정하는 데 사용됩니다.

반환

Promise<Response_2<OperationResponse[]>>

bulk(OperationInput[], BulkOptions, RequestOptions)

항목에 대한 대량 작업을 실행합니다.

대량 작업은 작업 수행에 따라 입력되는 작업의 배열을 사용합니다. 선택 항목은 만들기, Upsert, 읽기, 바꾸기 및 삭제입니다.

사용법 예제:

// partitionKey is optional at the top level if present in the resourceBody
const operations: OperationInput[] = [
   {
      operationType: "Create",
      resourceBody: { id: "doc1", name: "sample", key: "A" }
   },
   {
      operationType: "Upsert",
      partitionKey: 'A',
      resourceBody: { id: "doc2", name: "other", key: "A" }
   }
]

await database.container.items.bulk(operations)

function bulk(operations: OperationInput[], bulkOptions?: BulkOptions, options?: RequestOptions): Promise<BulkOperationResponse>

매개 변수

operations

OperationInput[]

작업 목록입니다. 제한 100

bulkOptions
BulkOptions

대량 동작을 수정하는 선택적 옵션 개체입니다. { continueOnError: true }를 전달하여 작업이 실패할 때 작업을 계속 실행합니다. (기본값은 false) ** 참고: 4.0 릴리스에서 기본값은 TRUE입니다.

options
RequestOptions

요청을 수정하는 데 사용됩니다.

반환

Promise<BulkOperationResponse>

changeFeed(ChangeFeedOptions)

변경 내용을 반복하는 을 ChangeFeedIterator 만듭니다.

function changeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

매개 변수

changeFeedOptions
ChangeFeedOptions

반환

ChangeFeedIterator<any>

changeFeed(PartitionKey, ChangeFeedOptions)

변경 내용을 반복하는 을 ChangeFeedIterator 만듭니다.

예제

변경 피드의 시작 부분에서 읽습니다.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();

function changeFeed(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

매개 변수

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

반환

ChangeFeedIterator<any>

changeFeed<T>(ChangeFeedOptions)

변경 내용을 반복하는 을 ChangeFeedIterator 만듭니다.

function changeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

매개 변수

changeFeedOptions
ChangeFeedOptions

반환

ChangeFeedIterator<T>

changeFeed<T>(PartitionKey, ChangeFeedOptions)

변경 내용을 반복하는 을 ChangeFeedIterator 만듭니다.

function changeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

매개 변수

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

반환

ChangeFeedIterator<T>

create<T>(T, RequestOptions)

항목을 만듭니다.

제공된 모든 형식 T가 반드시 SDK에 의해 적용되는 것은 아닙니다. 더 많거나 적은 속성을 얻을 수 있으며 이를 적용하는 것은 논리에 달려 있습니다.

JSON 항목에 대해 설정된 스키마가 없습니다. 여기에는 사용자 지정 속성의 개수가 포함될 수 있습니다.

function create<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>

매개 변수

body

T

항목의 본문을 나타냅니다. 사용자 정의 속성 수를 포함할 수 있습니다.

options
RequestOptions

요청을 수정하는 데 사용됩니다(instance 파티션 키 지정).

반환

Promise<ItemResponse<T>>

getChangeFeedIterator<T>(ChangeFeedIteratorOptions)

변경 내용을 반복하는 반복기를 반환합니다. 반환된 반복기를 사용하여 단일 파티션 키, 피드 범위 또는 전체 컨테이너에 대한 변경 내용을 가져올 수 있습니다.

function getChangeFeedIterator<T>(changeFeedIteratorOptions?: ChangeFeedIteratorOptions): ChangeFeedPullModelIterator<T>

매개 변수

changeFeedIteratorOptions
ChangeFeedIteratorOptions

반환

ChangeFeedPullModelIterator<T>

query(string | SqlQuerySpec, FeedOptions)

모든 항목을 쿼리합니다.

예제

배열에 대한 모든 항목을 읽습니다.

const querySpec: SqlQuerySpec = {
  query: "SELECT * FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query(querySpec).fetchAll();

function query(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

매개 변수

query

string | SqlQuerySpec

작업에 대한 쿼리 구성입니다. 쿼리를 구성하는 방법에 대한 자세한 내용은 SqlQuerySpec 을 참조하세요.

options
FeedOptions

요청을 수정하는 데 사용됩니다(instance 파티션 키 지정).

반환

QueryIterator<any>

query<T>(string | SqlQuerySpec, FeedOptions)

모든 항목을 쿼리합니다.

예제

배열에 대한 모든 항목을 읽습니다.

const querySpec: SqlQuerySpec = {
  query: "SELECT firstname FROM Families f WHERE f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Hendricks"}
  ]
};
const {result: items} = await items.query<{firstName: string}>(querySpec).fetchAll();

function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

매개 변수

query

string | SqlQuerySpec

작업에 대한 쿼리 구성입니다. 쿼리를 구성하는 방법에 대한 자세한 내용은 SqlQuerySpec 을 참조하세요.

options
FeedOptions

요청을 수정하는 데 사용됩니다(instance 파티션 키 지정).

반환

QueryIterator<T>

readAll(FeedOptions)

모든 항목을 읽습니다.

JSON 항목에 대해 설정된 스키마가 없습니다. 여기에는 사용자 지정 속성의 개수가 포함될 수 있습니다.

예제

배열에 대한 모든 항목을 읽습니다.

const {body: containerList} = await items.readAll().fetchAll();

function readAll(options?: FeedOptions): QueryIterator<ItemDefinition>

매개 변수

options
FeedOptions

요청을 수정하는 데 사용됩니다(instance 파티션 키 지정).

반환

QueryIterator<ItemDefinition>

readAll<T>(FeedOptions)

모든 항목을 읽습니다.

제공된 모든 형식 T가 반드시 SDK에 의해 적용되는 것은 아닙니다. 더 많거나 적은 속성을 얻을 수 있으며 이를 적용하는 것은 논리에 달려 있습니다.

JSON 항목에 대해 설정된 스키마가 없습니다. 여기에는 사용자 지정 속성의 개수가 포함될 수 있습니다.

예제

배열에 대한 모든 항목을 읽습니다.

const {body: containerList} = await items.readAll().fetchAll();

function readAll<T>(options?: FeedOptions): QueryIterator<T>

매개 변수

options
FeedOptions

요청을 수정하는 데 사용됩니다(instance 파티션 키 지정).

반환

QueryIterator<T>

readChangeFeed(ChangeFeedOptions)

경고

이 API는 이제 사용되지 않습니다.

Use changeFeed instead.

변경 내용을 반복하는 을 ChangeFeedIterator 만듭니다.

function readChangeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

매개 변수

changeFeedOptions
ChangeFeedOptions

반환

ChangeFeedIterator<any>

readChangeFeed(PartitionKey, ChangeFeedOptions)

경고

이 API는 이제 사용되지 않습니다.

Use changeFeed instead.

변경 내용을 반복하는 을 ChangeFeedIterator 만듭니다.

예제

변경 피드의 시작 부분에서 읽습니다.

const iterator = items.readChangeFeed({ startFromBeginning: true });
const firstPage = await iterator.fetchNext();
const firstPageResults = firstPage.result
const secondPage = await iterator.fetchNext();

function readChangeFeed(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>

매개 변수

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

반환

ChangeFeedIterator<any>

readChangeFeed<T>(ChangeFeedOptions)

경고

이 API는 이제 사용되지 않습니다.

Use changeFeed instead.

변경 내용을 반복하는 을 ChangeFeedIterator 만듭니다.

function readChangeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

매개 변수

changeFeedOptions
ChangeFeedOptions

반환

ChangeFeedIterator<T>

readChangeFeed<T>(PartitionKey, ChangeFeedOptions)

경고

이 API는 이제 사용되지 않습니다.

Use changeFeed instead.

변경 내용을 반복하는 을 ChangeFeedIterator 만듭니다.

function readChangeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>

매개 변수

partitionKey
PartitionKey
changeFeedOptions
ChangeFeedOptions

반환

ChangeFeedIterator<T>

upsert(unknown, RequestOptions)

항목을 Upsert합니다.

JSON 항목에 대해 설정된 스키마가 없습니다. 여기에는 사용자 지정 속성의 개수가 포함될 수 있습니다.

function upsert(body: unknown, options?: RequestOptions): Promise<ItemResponse<ItemDefinition>>

매개 변수

body

unknown

항목의 본문을 나타냅니다. 사용자 정의 속성 수를 포함할 수 있습니다.

options
RequestOptions

요청을 수정하는 데 사용됩니다(instance 파티션 키 지정).

반환

Promise<ItemResponse<ItemDefinition>>

upsert<T>(T, RequestOptions)

항목을 Upsert합니다.

제공된 모든 형식 T가 반드시 SDK에 의해 적용되는 것은 아닙니다. 더 많거나 적은 속성을 얻을 수 있으며 이를 적용하는 것은 논리에 달려 있습니다.

JSON 항목에 대해 설정된 스키마가 없습니다. 여기에는 사용자 지정 속성의 개수가 포함될 수 있습니다.

function upsert<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>

매개 변수

body

T

항목의 본문을 나타냅니다. 사용자 정의 속성 수를 포함할 수 있습니다.

options
RequestOptions

요청을 수정하는 데 사용됩니다(instance 파티션 키 지정).

반환

Promise<ItemResponse<T>>