@azure/cosmos
Version:
Microsoft Azure Cosmos DB Service Node.js SDK for SQL API
148 lines • 5.72 kB
JavaScript
import { createDocumentUri, getIdFromLink, getPathFromLink, isItemResourceValid, ResourceType, StatusCodes, } from "../../common";
import { extractPartitionKey, undefinedPartitionKey } from "../../extractPartitionKey";
import { ItemResponse } from "./ItemResponse";
/**
* Used to perform operations on a specific item.
*
* @see {@link Items} for operations on all items; see `container.items`.
*/
export class Item {
/**
* @hidden
* @param container - The parent {@link Container}.
* @param id - The id of the given {@link Item}.
* @param partitionKey - The primary key of the given {@link Item} (only for partitioned containers).
*/
constructor(container, id, partitionKey, clientContext) {
this.container = container;
this.id = id;
this.clientContext = clientContext;
this.partitionKey = partitionKey;
}
/**
* Returns a reference URL to the resource. Used for linking in Permissions.
*/
get url() {
return createDocumentUri(this.container.database.id, this.container.id, this.id);
}
/**
* Read the item's definition.
*
* Any provided type, T, is not necessarily enforced by the SDK.
* You may get more or less properties and it's up to your logic to enforce it.
* If the type, T, is a class, it won't pass `typeof` comparisons, because it won't have a match prototype.
* It's recommended to only use interfaces.
*
* There is no set schema for JSON items. They may contain any number of custom properties.
*
* @param options - Additional options for the request
*
* @example Using custom type for response
* ```typescript
* interface TodoItem {
* title: string;
* done: bool;
* id: string;
* }
*
* let item: TodoItem;
* ({body: item} = await item.read<TodoItem>());
* ```
*/
async read(options = {}) {
if (this.partitionKey === undefined) {
const { resource: partitionKeyDefinition } = await this.container.readPartitionKeyDefinition();
this.partitionKey = undefinedPartitionKey(partitionKeyDefinition);
}
const path = getPathFromLink(this.url);
const id = getIdFromLink(this.url);
let response;
try {
response = await this.clientContext.read({
path,
resourceType: ResourceType.item,
resourceId: id,
options,
partitionKey: this.partitionKey,
});
}
catch (error) {
if (error.code !== StatusCodes.NotFound) {
throw error;
}
response = error;
}
return new ItemResponse(response.result, response.headers, response.code, response.substatus, this);
}
async replace(body, options = {}) {
if (this.partitionKey === undefined) {
const { resource: partitionKeyDefinition } = await this.container.readPartitionKeyDefinition();
this.partitionKey = extractPartitionKey(body, partitionKeyDefinition);
}
const err = {};
if (!isItemResourceValid(body, err)) {
throw err;
}
const path = getPathFromLink(this.url);
const id = getIdFromLink(this.url);
const response = await this.clientContext.replace({
body,
path,
resourceType: ResourceType.item,
resourceId: id,
options,
partitionKey: this.partitionKey,
});
return new ItemResponse(response.result, response.headers, response.code, response.substatus, this);
}
/**
* Delete the item.
*
* Any provided type, T, is not necessarily enforced by the SDK.
* You may get more or less properties and it's up to your logic to enforce it.
*
* @param options - Additional options for the request
*/
async delete(options = {}) {
if (this.partitionKey === undefined) {
const { resource: partitionKeyDefinition } = await this.container.readPartitionKeyDefinition();
this.partitionKey = undefinedPartitionKey(partitionKeyDefinition);
}
const path = getPathFromLink(this.url);
const id = getIdFromLink(this.url);
const response = await this.clientContext.delete({
path,
resourceType: ResourceType.item,
resourceId: id,
options,
partitionKey: this.partitionKey,
});
return new ItemResponse(response.result, response.headers, response.code, response.substatus, this);
}
/**
* Perform a JSONPatch on the item.
*
* Any provided type, T, is not necessarily enforced by the SDK.
* You may get more or less properties and it's up to your logic to enforce it.
*
* @param options - Additional options for the request
*/
async patch(body, options = {}) {
if (this.partitionKey === undefined) {
const { resource: partitionKeyDefinition } = await this.container.readPartitionKeyDefinition();
this.partitionKey = extractPartitionKey(body, partitionKeyDefinition);
}
const path = getPathFromLink(this.url);
const id = getIdFromLink(this.url);
const response = await this.clientContext.patch({
body,
path,
resourceType: ResourceType.item,
resourceId: id,
options,
partitionKey: this.partitionKey,
});
return new ItemResponse(response.result, response.headers, response.code, response.substatus, this);
}
}
//# sourceMappingURL=Item.js.map