@qore/cli

qore cli

• Usage
• Commands

Usage

$ npm install -g @qorebase/cli
$ qore COMMAND
running command...
$ qore (-v|--version|version)
@qorebase/cli/1.0.12 linux-x64 node-v18.12.1
$ qore --help [COMMAND]
USAGE
  $ qore COMMAND
...

Commands

• qore alter-column [FORMERNAME] [NEWNAME]
• qore alter-permission
• qore alter-role [FORMERNAME] [NEWNAME]
• qore alter-table [FORMERNAME] [NEWNAME]
• qore codegen
• qore context
• qore create-column
• qore create-permission
• qore create-relation [RELATIONTYPE] [TABLEORIGIN] [TABLETARGET]
• qore create-roles [ROLES]
• qore create-tables [TABLESNAME]
• qore drop-columns [COLUMNSNAME]
• qore drop-permission [ACTION]
• qore drop-relation [RELATIONTYPE] [TABLEORIGIN/TABLEONE] [TABLETARGET/TABLEMANY]
• qore drop-roles [ROLES]
• qore drop-tables [TABLESNAME]
• qore export-schema
• qore help [COMMAND]
• qore import-schema
• qore login
• qore logout
• qore open-dashboard
• qore open-doc
• qore ping
• qore read-migrations
• qore rollback [STEPS]
• qore select [TABLENAME]

qore alter-column [FORMERNAME] [NEWNAME]

Rename column from specific table

USAGE
  $ qore alter-column [FORMERNAME] [NEWNAME]

OPTIONS
  --table=table  (required) tableName

EXAMPLES
  $ qore alter-column formerName newName --table tableName

See code: src/commands/alter-column.ts

qore alter-permission

Change condition in permissions table for specific role

USAGE
  $ qore alter-permission

OPTIONS
  --action=action        (required) action
  --condition=condition  (required) condition
  --role=role            (required) roleName
  --tables=tables        (required) tables

EXAMPLES
  $ qore alter-permission --role users --action select --condition '{"$and": [ { "title": { "$eq": "sleeping" } } ]}' 
  --tables all
  $ qore alter-permission --role users --action delete --condition  '{"$and": [ { "title": { "$eq": "add fitur login" } 
  } ]}' --tables todos,projects

See code: src/commands/alter-permission.ts

qore alter-role [FORMERNAME] [NEWNAME]

Rename specific role

USAGE
  $ qore alter-role [FORMERNAME] [NEWNAME]

EXAMPLE
  $ qore alter-role formerName newName

See code: src/commands/alter-role.ts

qore alter-table [FORMERNAME] [NEWNAME]

Rename specific table

USAGE
  $ qore alter-table [FORMERNAME] [NEWNAME]

EXAMPLE
  $ qore alter-table formerName newName

See code: src/commands/alter-table.ts

qore codegen

Generate qore project files

USAGE
  $ qore codegen

OPTIONS
  --adminSecret=adminSecret  admin secret
  --path=path                path
  --url=url                  project url

EXAMPLE
  $ qore codegen --project projectId --org orgId

See code: src/commands/codegen.ts

qore context

Set base url for project access

USAGE
  $ qore context

EXAMPLE
  $ qore set-url

See code: src/commands/context.ts

qore create-column

Create new columns in specific table

USAGE
  $ qore create-column

EXAMPLE
  $ qore create-column

See code: src/commands/create-column.ts

qore create-permission

Create permission for specific role in specific tables

USAGE
  $ qore create-permission

OPTIONS
  --actions=actions      (required) actions
  --condition=condition  condition
  --role=role            (required) roleName
  --tables=tables        (required) tables

EXAMPLE
  $ qore create-permission --role users --tables todos,projects --actions select,delete --condition '{"$and": []}'

See code: src/commands/create-permission.ts

qore create-relation [RELATIONTYPE] [TABLEORIGIN] [TABLETARGET]

Create relation 1:m for one-to-many or m:n for many-to-many relation

USAGE
  $ qore create-relation [RELATIONTYPE] [TABLEORIGIN] [TABLETARGET]

OPTIONS
  --relation=relation  relationName

EXAMPLE
  $ qore create-relation relationType tableOrigin tableTarget --relation personTodo

See code: src/commands/create-relation.ts

qore create-roles [ROLES]

Create new roles

USAGE
  $ qore create-roles [ROLES]

EXAMPLE
  $ qore create-roles user,engineer

See code: src/commands/create-roles.ts

qore create-tables [TABLESNAME]

Create tables

USAGE
  $ qore create-tables [TABLESNAME]

ARGUMENTS
  TABLESNAME  list of table name

EXAMPLES
  $ qore create-tables todos
  $ qore create-tables todos,projects

See code: src/commands/create-tables.ts

qore drop-columns [COLUMNSNAME]

Drop columns from specific table

USAGE
  $ qore drop-columns [COLUMNSNAME]

ARGUMENTS
  COLUMNSNAME  list of column name

OPTIONS
  --table=table  (required) tableName

EXAMPLE
  $ qore drop-columns title,status --table todos

See code: src/commands/drop-columns.ts

qore drop-permission [ACTION]

Drop action permission for role in tables

USAGE
  $ qore drop-permission [ACTION]

ARGUMENTS
  ACTION  actionName

OPTIONS
  --role=role      (required) roleName
  --tables=tables  (required) tables

EXAMPLES
  $ qore drop-permission select --role user --tables all
  $ qore drop-permission delete --role user --tables todos,projects

See code: src/commands/drop-permission.ts

qore drop-relation [RELATIONTYPE] [TABLEORIGIN/TABLEONE] [TABLETARGET/TABLEMANY]

Drop relation column in 1:m or drop junction table if m:n relation

USAGE
  $ qore drop-relation [RELATIONTYPE] [TABLEORIGIN/TABLEONE] [TABLETARGET/TABLEMANY]

OPTIONS
  --relation=relation  (required) relationName

EXAMPLES
  $ qore drop-relation 1:m tableOrigin/tableOne tableTarget/tableMany --relation personTodo
  $ qore drop-relation m:n tableOrigin/tableOne tableTarget/tableMany --relation personProject

See code: src/commands/drop-relation.ts

qore drop-roles [ROLES]

Drop some roles

USAGE
  $ qore drop-roles [ROLES]

ARGUMENTS
  ROLES  list role name

EXAMPLES
  $ qore drop-roles users,engineer
  $ qore drop-roles developer

See code: src/commands/drop-roles.ts

qore drop-tables [TABLESNAME]

Drop specific table

USAGE
  $ qore drop-tables [TABLESNAME]

ARGUMENTS
  TABLESNAME  list of table name

EXAMPLES
  $ qore drop-tables todos
  $ qore drop-tables todos,projects

See code: src/commands/drop-tables.ts

qore export-schema

Populate json file for all migrations process

USAGE
  $ qore export-schema

OPTIONS
  --location=location  [default: migrations] fileLocation

EXAMPLE
  $ qore export-schema --location migrations

See code: src/commands/export-schema.ts

qore help [COMMAND]

display help for qore

USAGE
  $ qore help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

qore import-schema

Import-schema in specific folder for other database architecture

USAGE
  $ qore import-schema

OPTIONS
  -l, --location=location  [default: migrations] fileLocation

EXAMPLE
  $ qore import-schema --location

See code: src/commands/import-schema.ts

qore login

Login to qore cli

USAGE
  $ qore login

OPTIONS
  --adminSecret=adminSecret  admin secret
  --url=url                  url

EXAMPLE
  $ qore login

See code: src/commands/login.ts

qore logout

Logout from qore cli

USAGE
  $ qore logout

EXAMPLE
  $ qore logout

See code: src/commands/logout.ts

qore open-dashboard

Open project dashboard on browser

USAGE
  $ qore open-dashboard

EXAMPLE
  $ qore open-dashboard

See code: src/commands/open-dashboard.ts

qore open-doc

Open project doc on browser

USAGE
  $ qore open-doc

EXAMPLE
  $ qore open-doc

See code: src/commands/open-doc.ts

qore ping

Ping

USAGE
  $ qore ping

EXAMPLE
  $ qore ping

See code: src/commands/ping.ts

qore read-migrations

Read/see migrations histories

USAGE
  $ qore read-migrations

OPTIONS
  --limit=limit    limit
  --offset=offset  offset

EXAMPLE
  $ qore read-migrations --limit 0 --offset 0

See code: src/commands/read-migrations.ts

qore rollback [STEPS]

Rollback to previous migration

USAGE
  $ qore rollback [STEPS]

ARGUMENTS
  STEPS  Number of Rollbacks

EXAMPLE
  $ qore rollback 10

See code: src/commands/rollback.ts

qore select [TABLENAME]

Get all rows from specific table

USAGE
  $ qore select [TABLENAME]

OPTIONS
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

EXAMPLE
  $ qore select tableName

See code: src/commands/select.ts