Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

dbdocs

Package Overview
Dependencies
Maintainers
0
Versions
35
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

dbdocs

dbdocs ======

  • 0.14.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
0
Created
Source

dbdocs

oclif Version Downloads/week License

Usage

$ npm install -g dbdocs
$ dbdocs COMMAND
running command...
$ dbdocs (-v|--version|version)
dbdocs/0.6.2 darwin-x64 node-v15.10.0
$ dbdocs --help [COMMAND]
USAGE
  $ dbdocs COMMAND
...

Commands

dbdocs build [FILEPATH]

build docs

USAGE
  $ dbdocs build [FILEPATH]

ARGUMENTS
  FILEPATH  dbml file path

OPTIONS
  -p, --password=password  password for project
  --project=project        project name

dbdocs db2dbml [DATABASE-TYPE] [CONNECTION-STRING]

Generate DBML directly from a database

USAGE
  $ dbdocs db2dbml [DATABASE-TYPE] [CONNECTION-STRING] [-o <value>]

ARGUMENTS
  DATABASE-TYPE      your database type (postgres, mysql, mssql, snowflake, bigquery)
  CONNECTION-STRING  your database connection string (See below examples for more details)

FLAGS
  -o, --outFile=/path-to-your-file  output file path

DESCRIPTION
  Generate DBML directly from a database

EXAMPLES
  Postgres:
    $ db2dbml postgres 'postgresql://user:password@localhost:5432/dbname?schemas=schema1,schema2'
  MySQL:
    $ db2dbml mysql 'mysql://user:password@localhost:3306/dbname'
  MSSQL:
    $ db2dbml mssql 'Server=localhost,1433;Database=master;User Id=sa;Password=your_password;Encrypt=true;TrustServerCertificate=true;Schemas=schema1,schema2;'
  Snowflake:
    $ db2dbml snowflake 'SERVER=<account_identifier>.<region>;UID=<your_username>;PWD=<your_password>;DATABASE=<your_database>;WAREHOUSE=<your_warehouse>;ROLE=<your_role>;SCHEMAS=schema1,schema2;'
  BigQuery:
    $ db2dbml bigquery /path_to_json_credential.json

    Note: Your JSON credential file must contain:
    {
      "project_id": "your-project-id",
      "client_email": "your-client-email",
      "private_key": "your-private-key",
      "datasets": ["dataset_1", "dataset_2", ...]
    }
    If "datasets" key is not provided or is empty, it will fetch all datasets.

dbdocs help [COMMAND]

display help for dbdocs

USAGE
  $ dbdocs help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

dbdocs login

login to dbdocs

USAGE
  $ dbdocs login

DESCRIPTION
  login with your dbdocs credentials

dbdocs logout

logout

USAGE
  $ dbdocs logout

DESCRIPTION
  clears local login credentials

dbdocs ls

list projects

USAGE
  $ dbdocs ls

DESCRIPTION
  list all projects in your default organization

dbdocs password

set password for your project or remove password

USAGE
  $ dbdocs password

OPTIONS
  -p, --project=project name  project name
  -r, --remove                remove password from your project
  -s, --set=password          password for your project

dbdocs remove [PROJECT_NAME]

remove project

USAGE
  $ dbdocs remove [PROJECT_NAME]

ARGUMENTS
  PROJECT_NAME  name of the project which you want to remove

dbdocs rename

change your username

USAGE
  $ dbdocs rename

DESCRIPTION
  change your username and your default organization name

dbdocs set

Set the Web URL and API URL of dbdocs self-hosted server

USAGE
  $ dbdocs set --webUrl <value> --apiUrl <value>

FLAGS
  --apiUrl=<value>  (required) Self-hosted api url
  --webUrl=<value>  (required) Self-hosted web url

DESCRIPTION
  Set the Web URL and API URL of dbdocs self-hosted server

EXAMPLES
  $ dbdocs set --webUrl http://webserver.dev --apiUrl http://apiserver.dev

dbdocs token

generate or revoke your authentication token

USAGE
  $ dbdocs token

OPTIONS
  -g, --generate  generate authentication token
  -r, --revoke    revoke authentication token

dbdocs validate [FILEPATH]

validate docs content

USAGE
  $ dbdocs validate [FILEPATH]

ARGUMENTS
  FILEPATH  dbml file path

Keywords

FAQs

Package last updated on 17 Oct 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc