@rockset/cli/lib/commands/api/documents/deleteDocuments.js

Official Rockset CLI

"use strict";
/* eslint-disable unicorn/filename-case */
// Generated file, please do not edit directly
Object.defineProperty(exports, "__esModule", { value: true });
const core_1 = require("@oclif/core");
const core_2 = require("@rockset/core");
const util_1 = require("../../../helper/util");
const base_command_1 = require("../../../base-command");
const chalk = require("chalk");
const cli_ux_1 = require("cli-ux");
const bodySchema = `data:
  - _id: 2cd61e3b
`;
let DeleteDocuments = /** @class */ (() => {
    class DeleteDocuments extends base_command_1.RockCommand {
        async run() {
            const { args, flags } = await this.parse(DeleteDocuments);
            // Rockset client object
            const client = await core_2.main.createClient();
            const namedArgs = DeleteDocuments.args;
            // apicall
            const apicall = client.documents.deleteDocuments.bind(client.documents);
            // endpoint
            const endpoint = '/v1/orgs/self/ws/{workspace}/collections/{collection}/docs';
            const method = 'DELETE';
            await util_1.runApiCall.bind(this)({ args, flags, namedArgs, apicall, method, endpoint, bodySchema });
        }
    }
    DeleteDocuments.flags = Object.assign(Object.assign({ help: core_1.Flags.help({ char: 'h' }), body: core_1.Flags.string({
            required: true,
            description: 'Path to a file whose contents will be passed as the POST body of this request. Format must be [json|yaml]. An example schema is shown below.',
        }), raw: core_1.Flags.boolean({
            description: 'Show the raw output from the server, instead of grabbing the results. Usually used in conjunction with --output=json',
        }) }, cli_ux_1.cli.table.flags({ only: ['columns', 'output'] })), { loadTestRps: core_1.Flags.integer({
            char: 'l',
            description: 'If this flag is active, a load test will be conducted using this endpoint. The value passed to this flag determines how many requests per second will be sent',
        }), yes: core_1.Flags.boolean({
            char: 'y',
            description: 'Skip all safety prompts',
            default: false,
        }) });
    DeleteDocuments.args = [
        {
            name: 'workspace',
            description: 'Name of the workspace.',
            required: true,
            hidden: false,
        },
        {
            name: 'collection',
            description: 'Name of the collection.',
            required: true,
            hidden: false,
        },
    ];
    DeleteDocuments.description = `delete documents from a collection
Arguments to this command will be passed as URL parameters to ${chalk.bold(`DELETE: /v1/orgs/self/ws/{workspace}/collections/{collection}/docs`)}
${chalk.bold(`This endpoint REQUIRES a DELETE body. To specify a DELETE body, please pass a JSON or YAML file to the --body flag.
       `)}
Example Body (YAML):
data:
  - _id: 2cd61e3b


Endpoint Reference
DELETE: /v1/orgs/self/ws/{workspace}/collections/{collection}/docs
Delete Documents
Delete documents from a collection.

More documentation at ${chalk.underline(`https://docs.rockset.com/rest-api#deletedocuments`)}`;
    DeleteDocuments.examples = [
        '$ rockset api:documents:deleteDocuments WORKSPACE COLLECTION --body body.yaml\n$ cat body.yaml\ndata:\n  - _id: 2cd61e3b\n\n',
    ];
    return DeleteDocuments;
})();
exports.default = DeleteDocuments;