0.6.0 • Published 5 months ago

@propps/bigquery-ts v0.6.0

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

@propps/bigquery-ts

Create Typescript type definitions and Zod schemas based on BigQuery table JSON schemas.

oclif Version CircleCI Downloads/week License

Usage

$ npm install -g @propps/bigquery-ts
$ bigquery-ts COMMAND
running command...
$ bigquery-ts (--version)
@propps/bigquery-ts/0.6.0 darwin-arm64 node-v16.20.1
$ bigquery-ts --help [COMMAND]
USAGE
  $ bigquery-ts COMMAND
...

Commands

bigquery-ts generate:dir DIRECTORY

Generate TS files for multiple BigQuery schemas with a single export file

USAGE
  $ bigquery-ts generate:dir DIRECTORY [-o <value>]

ARGUMENTS
  DIRECTORY  Directory where the schema files are located

FLAGS
  -o, --output=<value>  Where to write the generated files

DESCRIPTION
  Generate TS files for multiple BigQuery schemas with a single export file

EXAMPLES
  $ bigquery-ts generate /path/to/schema.json --output /path/to/output/dir

See code: src/commands/generate/dir.ts

bigquery-ts generate:file SCHEMA

Generate a single TS file for a BigQuery schema

USAGE
  $ bigquery-ts generate:file SCHEMA [-o <value>]

ARGUMENTS
  SCHEMA  BigQuery table schema JSON

FLAGS
  -o, --output=<value>  Where to write the generated files

DESCRIPTION
  Generate a single TS file for a BigQuery schema

EXAMPLES
  $ bigquery-ts generate /path/to/schema.json --output /path/to/output/dir

See code: src/commands/generate/file.ts

bigquery-ts help [COMMANDS]

Display help for bigquery-ts.

USAGE
  $ bigquery-ts help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for bigquery-ts.

See code: @oclif/plugin-help

bigquery-ts plugins

List installed plugins.

USAGE
  $ bigquery-ts plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ bigquery-ts plugins

See code: @oclif/plugin-plugins

bigquery-ts plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ bigquery-ts plugins:add plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -s, --silent   Silences yarn output.
  -v, --verbose  Show verbose yarn output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ bigquery-ts plugins:add

EXAMPLES
  $ bigquery-ts plugins:add myplugin 

  $ bigquery-ts plugins:add https://github.com/someuser/someplugin

  $ bigquery-ts plugins:add someuser/someplugin

bigquery-ts plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ bigquery-ts plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ bigquery-ts plugins:inspect myplugin

See code: @oclif/plugin-plugins

bigquery-ts plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ bigquery-ts plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -s, --silent   Silences yarn output.
  -v, --verbose  Show verbose yarn output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ bigquery-ts plugins:add

EXAMPLES
  $ bigquery-ts plugins:install myplugin 

  $ bigquery-ts plugins:install https://github.com/someuser/someplugin

  $ bigquery-ts plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

bigquery-ts plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ bigquery-ts plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ bigquery-ts plugins:link myplugin

See code: @oclif/plugin-plugins

bigquery-ts plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ bigquery-ts plugins:remove plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ bigquery-ts plugins:unlink
  $ bigquery-ts plugins:remove

EXAMPLES
  $ bigquery-ts plugins:remove myplugin

bigquery-ts plugins:reset

Remove all user-installed and linked plugins.

USAGE
  $ bigquery-ts plugins:reset

See code: @oclif/plugin-plugins

bigquery-ts plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ bigquery-ts plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ bigquery-ts plugins:unlink
  $ bigquery-ts plugins:remove

EXAMPLES
  $ bigquery-ts plugins:uninstall myplugin

See code: @oclif/plugin-plugins

bigquery-ts plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ bigquery-ts plugins:unlink plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ bigquery-ts plugins:unlink
  $ bigquery-ts plugins:remove

EXAMPLES
  $ bigquery-ts plugins:unlink myplugin

bigquery-ts plugins:update

Update installed plugins.

USAGE
  $ bigquery-ts plugins:update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins