@rockset/cli/lib/commands/api/collections/getCollection.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 = ``;
let GetCollection = /** @class */ (() => {
    class GetCollection extends base_command_1.RockCommand {
        async run() {
            const { args, flags } = await this.parse(GetCollection);
            // Rockset client object
            const client = await core_2.main.createClient();
            const namedArgs = GetCollection.args;
            // apicall
            const apicall = client.collections.getCollection.bind(client.collections);
            // endpoint
            const endpoint = '/v1/orgs/self/ws/{workspace}/collections/{collection}';
            const method = 'GET';
            await util_1.runApiCall.bind(this)({ args, flags, namedArgs, apicall, method, endpoint, bodySchema });
        }
    }
    GetCollection.flags = Object.assign({ help: core_1.Flags.help({ char: 'h' }), 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'] }));
    GetCollection.args = [
        {
            name: 'workspace',
            description: 'name of the workspace',
            required: true,
            hidden: false,
        },
        {
            name: 'collection',
            description: 'name of the collection',
            required: true,
            hidden: false,
        },
    ];
    GetCollection.description = `get details about a collection
Arguments to this command will be passed as URL parameters to ${chalk.bold(`GET: /v1/orgs/self/ws/{workspace}/collections/{collection}`)}


Endpoint Reference
GET: /v1/orgs/self/ws/{workspace}/collections/{collection}
Retrieve Collection
Get details about a collection.

More documentation at ${chalk.underline(`https://docs.rockset.com/rest-api#getcollection`)}`;
    GetCollection.examples = ['$ rockset api:collections:getCollection WORKSPACE COLLECTION'];
    return GetCollection;
})();
exports.default = GetCollection;