Command Reference ( datasource mode )

List of datasource mode commands.

datasource ( data_delete ) : cmdbox -m datasource -c data_delete <Option>

  • Deletes records from a table of the specified datasource.

Option

Type

Multi

Required

Default

Choices

Description

--host <host>

str

required

localhost

Specify the service host of the Redis server.

--port <port>

int

required

6379

Specify the service port of the Redis server.

--password <password>

passwd

required

password

Specify the access password of the Redis server (optional). If omitted, password is used.

--svname <svname>

str

required

cmdbox

Specify the service name of the inference server. If omitted, server is used.

--retry_count <retry_count>

int

3

Specifies the number of reconnections to the Redis server. If less than 0 is specified, reconnection is forever.

--retry_interval <retry_interval>

int

5

Specifies the number of seconds before reconnecting to the Redis server.

--timeout <timeout>

int

60

Specify the maximum waiting time until the server responds.

--dsname <dsname>

str

required

Specify the identifier name of the target datasource.

--schema <schema>

str

Specify the schema name. If omitted, the operation is performed without a schema.

--tblname <tblname>

str

required

Specify the target table name.

--where_data <where_data>

dict

multi

Specify WHERE condition column names and values in key=value format (AND join). Repeat for multiple conditions. If omitted, all rows are deleted.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field

Type

Required

Default

Description

success

Data | null

no

null

成功した場合の結果

success.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

success.data

str | null

no

null

処理結果のデータ

warn

dict[str, any] | list[any] | Data | str | bool | null

no

null

警告がある場合の結果

warn.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

error

dict[str, any] | list[any] | Data | str | bool | null

no

null

エラーがある場合の結果

error.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

output_schema

dict[str, any] | null

no

null

スキーマ情報

end

bool | null

no

null

終了フラグ

datasource ( data_insert ) : cmdbox -m datasource -c data_insert <Option>

  • Inserts a record into a table of the specified datasource.

Option

Type

Multi

Required

Default

Choices

Description

--host <host>

str

required

localhost

Specify the service host of the Redis server.

--port <port>

int

required

6379

Specify the service port of the Redis server.

--password <password>

passwd

required

password

Specify the access password of the Redis server (optional). If omitted, password is used.

--svname <svname>

str

required

cmdbox

Specify the service name of the inference server. If omitted, server is used.

--retry_count <retry_count>

int

3

Specifies the number of reconnections to the Redis server. If less than 0 is specified, reconnection is forever.

--retry_interval <retry_interval>

int

5

Specifies the number of seconds before reconnecting to the Redis server.

--timeout <timeout>

int

60

Specify the maximum waiting time until the server responds.

--dsname <dsname>

str

required

Specify the identifier name of the target datasource.

--schema <schema>

str

Specify the schema name. If omitted, the operation is performed without a schema.

--tblname <tblname>

str

required

Specify the target table name.

--insert_data <insert_data>

dict

multi

required

Specify the column names and values of the record to insert in key=value format. Repeat for multiple columns.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field

Type

Required

Default

Description

success

Data | null

no

null

成功した場合の結果

success.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

success.data

str | null

no

null

処理結果のデータ

warn

dict[str, any] | list[any] | Data | str | bool | null

no

null

警告がある場合の結果

warn.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

error

dict[str, any] | list[any] | Data | str | bool | null

no

null

エラーがある場合の結果

error.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

output_schema

dict[str, any] | null

no

null

スキーマ情報

end

bool | null

no

null

終了フラグ

datasource ( data_select ) : cmdbox -m datasource -c data_select <Option>

  • Selects records from a table of the specified datasource.

Option

Type

Multi

Required

Default

Choices

Description

--host <host>

str

required

localhost

Specify the service host of the Redis server.

--port <port>

int

required

6379

Specify the service port of the Redis server.

--password <password>

passwd

required

password

Specify the access password of the Redis server (optional). If omitted, password is used.

--svname <svname>

str

required

cmdbox

Specify the service name of the inference server. If omitted, server is used.

--retry_count <retry_count>

int

3

Specifies the number of reconnections to the Redis server. If less than 0 is specified, reconnection is forever.

--retry_interval <retry_interval>

int

5

Specifies the number of seconds before reconnecting to the Redis server.

--timeout <timeout>

int

60

Specify the maximum waiting time until the server responds.

--dsname <dsname>

str

required

Specify the identifier name of the target datasource.

--schema <schema>

str

Specify the schema name. If omitted, the operation is performed without a schema.

--tblname <tblname>

str

required

Specify the target table name.

--column <column>

str

multi

Specify column names to retrieve. If omitted, all columns are retrieved. Repeat for multiple columns. e.g. id name age

--where_data <where_data>

dict

multi

Specify WHERE condition column names and values in key=value format (AND join). Repeat for multiple conditions.

--order_by <order_by>

str

Specify ORDER BY clause as comma-separated values. e.g. id DESC,name ASC

--limit <limit>

int

Specify the maximum number of rows to retrieve.

--offset <offset>

int

Specify the offset for the starting position of retrieval.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": [
      {}
    ]
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field

Type

Required

Default

Description

success

Data | null

no

null

成功した場合の結果

success.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

success.data

list[dict[str, any]]

no

(必須)

取得したレコードのリスト

warn

dict[str, any] | list[any] | Data | str | bool | null

no

null

警告がある場合の結果

warn.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

error

dict[str, any] | list[any] | Data | str | bool | null

no

null

エラーがある場合の結果

error.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

output_schema

dict[str, any] | null

no

null

スキーマ情報

end

bool | null

no

null

終了フラグ

datasource ( data_update ) : cmdbox -m datasource -c data_update <Option>

  • Updates records in a table of the specified datasource.

Option

Type

Multi

Required

Default

Choices

Description

--host <host>

str

required

localhost

Specify the service host of the Redis server.

--port <port>

int

required

6379

Specify the service port of the Redis server.

--password <password>

passwd

required

password

Specify the access password of the Redis server (optional). If omitted, password is used.

--svname <svname>

str

required

cmdbox

Specify the service name of the inference server. If omitted, server is used.

--retry_count <retry_count>

int

3

Specifies the number of reconnections to the Redis server. If less than 0 is specified, reconnection is forever.

--retry_interval <retry_interval>

int

5

Specifies the number of seconds before reconnecting to the Redis server.

--timeout <timeout>

int

60

Specify the maximum waiting time until the server responds.

--dsname <dsname>

str

required

Specify the identifier name of the target datasource.

--schema <schema>

str

Specify the schema name. If omitted, the operation is performed without a schema.

--tblname <tblname>

str

required

Specify the target table name.

--update_data <update_data>

dict

multi

required

Specify the column names and values to update in key=value format. Repeat for multiple columns.

--where_data <where_data>

dict

multi

Specify WHERE condition column names and values in key=value format (AND join). Repeat for multiple conditions.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field

Type

Required

Default

Description

success

Data | null

no

null

成功した場合の結果

success.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

success.data

str | null

no

null

処理結果のデータ

warn

dict[str, any] | list[any] | Data | str | bool | null

no

null

警告がある場合の結果

warn.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

error

dict[str, any] | list[any] | Data | str | bool | null

no

null

エラーがある場合の結果

error.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

output_schema

dict[str, any] | null

no

null

スキーマ情報

end

bool | null

no

null

終了フラグ

datasource ( del ) : cmdbox -m datasource -c del <Option>

  • Deletes a datasource connection configuration.

Option

Type

Multi

Required

Default

Choices

Description

--host <host>

str

required

localhost

Specify the service host of the Redis server.

--port <port>

int

required

6379

Specify the service port of the Redis server.

--password <password>

passwd

required

password

Specify the access password of the Redis server (optional). If omitted, password is used.

--svname <svname>

str

required

cmdbox

Specify the service name of the inference server. If omitted, server is used.

--retry_count <retry_count>

int

3

Specifies the number of reconnections to the Redis server. If less than 0 is specified, reconnection is forever.

--retry_interval <retry_interval>

int

5

Specifies the number of seconds before reconnecting to the Redis server.

--timeout <timeout>

int

60

Specify the maximum waiting time until the server responds.

--dsname <dsname>

str

required

Specify the identifier name of the datasource configuration to delete.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field

Type

Required

Default

Description

success

Data | null

no

null

成功した場合の結果

success.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

success.data

str | null

no

null

処理結果のデータ

warn

dict[str, any] | list[any] | Data | str | bool | null

no

null

警告がある場合の結果

warn.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

error

dict[str, any] | list[any] | Data | str | bool | null

no

null

エラーがある場合の結果

error.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

output_schema

dict[str, any] | null

no

null

スキーマ情報

end

bool | null

no

null

終了フラグ

datasource ( idx_create ) : cmdbox -m datasource -c idx_create <Option>

  • Creates an index on a table in the specified datasource.

Option

Type

Multi

Required

Default

Choices

Description

--host <host>

str

required

localhost

Specify the service host of the Redis server.

--port <port>

int

required

6379

Specify the service port of the Redis server.

--password <password>

passwd

required

password

Specify the access password of the Redis server (optional). If omitted, password is used.

--svname <svname>

str

required

cmdbox

Specify the service name of the inference server. If omitted, server is used.

--retry_count <retry_count>

int

3

Specifies the number of reconnections to the Redis server. If less than 0 is specified, reconnection is forever.

--retry_interval <retry_interval>

int

5

Specifies the number of seconds before reconnecting to the Redis server.

--timeout <timeout>

int

60

Specify the maximum waiting time until the server responds.

--dsname <dsname>

str

required

Specify the identifier name of the target datasource.

--schema <schema>

str

Specify the schema name. If omitted, the operation is performed without a schema.

--tblname <tblname>

str

required

Specify the table name on which to create the index.

--idxname <idxname>

str

required

Specify the index name to create.

--idxcolumns <idxcolumns>

str

multi

required

Specify the column names for the index. Multiple values can be specified. e.g. col1 col2

--unique <unique>

bool

False

True | False

Specify whether to create a unique index.

--if_not_exists <if_not_exists>

bool

False

True | False

Specify whether to suppress an error if the index already exists.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field

Type

Required

Default

Description

success

Data | null

no

null

成功した場合の結果

success.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

success.data

str | null

no

null

処理結果のデータ

warn

dict[str, any] | list[any] | Data | str | bool | null

no

null

警告がある場合の結果

warn.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

error

dict[str, any] | list[any] | Data | str | bool | null

no

null

エラーがある場合の結果

error.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

output_schema

dict[str, any] | null

no

null

スキーマ情報

end

bool | null

no

null

終了フラグ

datasource ( idx_drop ) : cmdbox -m datasource -c idx_drop <Option>

  • Drops an index from the specified datasource.

Option

Type

Multi

Required

Default

Choices

Description

--host <host>

str

required

localhost

Specify the service host of the Redis server.

--port <port>

int

required

6379

Specify the service port of the Redis server.

--password <password>

passwd

required

password

Specify the access password of the Redis server (optional). If omitted, password is used.

--svname <svname>

str

required

cmdbox

Specify the service name of the inference server. If omitted, server is used.

--retry_count <retry_count>

int

3

Specifies the number of reconnections to the Redis server. If less than 0 is specified, reconnection is forever.

--retry_interval <retry_interval>

int

5

Specifies the number of seconds before reconnecting to the Redis server.

--timeout <timeout>

int

60

Specify the maximum waiting time until the server responds.

--dsname <dsname>

str

required

Specify the identifier name of the target datasource.

--schema <schema>

str

Specify the schema name. If omitted, the operation is performed without a schema.

--idxname <idxname>

str

required

Specify the index name to drop.

--if_exists <if_exists>

bool

False

True | False

Specify whether to suppress an error if the index does not exist.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field

Type

Required

Default

Description

success

Data | null

no

null

成功した場合の結果

success.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

success.data

str | null

no

null

処理結果のデータ

warn

dict[str, any] | list[any] | Data | str | bool | null

no

null

警告がある場合の結果

warn.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

error

dict[str, any] | list[any] | Data | str | bool | null

no

null

エラーがある場合の結果

error.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

output_schema

dict[str, any] | null

no

null

スキーマ情報

end

bool | null

no

null

終了フラグ

datasource ( list ) : cmdbox -m datasource -c list <Option>

  • Lists registered datasource connection configurations.

Option

Type

Multi

Required

Default

Choices

Description

--host <host>

str

required

localhost

Specify the service host of the Redis server.

--port <port>

int

required

6379

Specify the service port of the Redis server.

--password <password>

passwd

required

password

Specify the access password of the Redis server (optional). If omitted, password is used.

--svname <svname>

str

required

cmdbox

Specify the service name of the inference server. If omitted, server is used.

--retry_count <retry_count>

int

3

Specifies the number of reconnections to the Redis server. If less than 0 is specified, reconnection is forever.

--retry_interval <retry_interval>

int

5

Specifies the number of seconds before reconnecting to the Redis server.

--timeout <timeout>

int

60

Specify the maximum waiting time until the server responds.

--kwd <kwd>

str

Specify the identifier name to search for. Searches for partial matches.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": [
      {
        "name": "string",
        "dbtype": "string",
        "scope": "string"
      }
    ]
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field

Type

Required

Default

Description

success

Data | null

no

null

成功した場合の結果

success.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

success.data

list[DsRecord]

no

(必須)

処理結果のデータ

success.data.name

str

yes

(必須)

データソース識別名

success.data.dbtype

str

yes

(必須)

データベース種別

success.data.scope

str

yes

(必須)

参照スコープ

warn

dict[str, any] | list[any] | Data | str | bool | null

no

null

警告がある場合の結果

warn.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

error

dict[str, any] | list[any] | Data | str | bool | null

no

null

エラーがある場合の結果

error.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

output_schema

dict[str, any] | null

no

null

スキーマ情報

end

bool | null

no

null

終了フラグ

datasource ( load ) : cmdbox -m datasource -c load <Option>

  • Loads a datasource connection configuration.

Option

Type

Multi

Required

Default

Choices

Description

--host <host>

str

required

localhost

Specify the service host of the Redis server.

--port <port>

int

required

6379

Specify the service port of the Redis server.

--password <password>

passwd

required

password

Specify the access password of the Redis server (optional). If omitted, password is used.

--svname <svname>

str

required

cmdbox

Specify the service name of the inference server. If omitted, server is used.

--retry_count <retry_count>

int

3

Specifies the number of reconnections to the Redis server. If less than 0 is specified, reconnection is forever.

--retry_interval <retry_interval>

int

5

Specifies the number of seconds before reconnecting to the Redis server.

--timeout <timeout>

int

60

Specify the maximum waiting time until the server responds.

--dsname <dsname>

str

required

Specify the identifier name of the datasource configuration to load.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": {
      "dsname": "string",
      "dbtype": "string",
      "scope": "string",
      "client_data": "string",
      "db_host": "string",
      "db_port": 0,
      "db_user": "string",
      "db_password": "string",
      "db_name": "string",
      "db_timeout": 0,
      "db_path": "string"
    }
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field

Type

Required

Default

Description

success

Data | null

no

null

成功した場合の結果

success.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

success.data

Configure | null

no

null

処理結果のデータ

success.data.dsname

str | null

no

null

データソース名

success.data.dbtype

str | null

no

null

データベース種別

success.data.scope

str | null

no

null

参照スコープ

success.data.client_data

str | null

no

null

クライアントスコープの場合のローカルデータパス

success.data.db_host

str | null

no

null

データベースホスト

success.data.db_port

int | null

no

null

データベースポート

success.data.db_user

str | null

no

null

データベースユーザー名

success.data.db_password

str | null

no

null

データベースパスワード

success.data.db_name

str | null

no

null

データベース名

success.data.db_timeout

int | null

no

null

データベース接続のタイムアウト(秒)

success.data.db_path

str | null

no

null

SQLiteデータベースファイルパス

warn

dict[str, any] | list[any] | Data | str | bool | null

no

null

警告がある場合の結果

warn.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

error

dict[str, any] | list[any] | Data | str | bool | null

no

null

エラーがある場合の結果

error.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

output_schema

dict[str, any] | null

no

null

スキーマ情報

end

bool | null

no

null

終了フラグ

datasource ( save ) : cmdbox -m datasource -c save <Option>

  • Adds or saves a datasource connection configuration.

Option

Type

Multi

Required

Default

Choices

Description

--host <host>

str

required

localhost

Specify the service host of the Redis server.

--port <port>

int

required

6379

Specify the service port of the Redis server.

--password <password>

passwd

required

password

Specify the access password of the Redis server (optional). If omitted, password is used.

--svname <svname>

str

required

cmdbox

Specify the service name of the inference server. If omitted, server is used.

--retry_count <retry_count>

int

3

Specifies the number of reconnections to the Redis server. If less than 0 is specified, reconnection is forever.

--retry_interval <retry_interval>

int

5

Specifies the number of seconds before reconnecting to the Redis server.

--timeout <timeout>

int

60

Specify the maximum waiting time until the server responds.

--dsname <dsname>

str

required

Specify the identifier name of the datasource connection configuration.

--dbtype <dbtype>

str

required

sqlite

postgresql | sqlite

Specify the database type.

--scope <scope>

str

required

server

client | current | server

Specify the scope. client refers to the client side, and server refers to the server side. current refers to the current directory.

--db_host <db_host>

str

localhost

Specify the database server host (for PostgreSQL).

--db_port <db_port>

int

5432

Specify the database server port (for PostgreSQL).

--db_user <db_user>

str

postgres

Specify the username for database connection (for PostgreSQL).

--db_password <db_password>

passwd

Specify the password for database connection (for PostgreSQL).

--db_name <db_name>

str

Specify the database name to connect to (for PostgreSQL).

--db_timeout <db_timeout>

int

120

Specify the database connection timeout (for PostgreSQL).

--db_path <db_path>

file

Specify the path to the SQLite database file (for SQLite).

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field

Type

Required

Default

Description

success

Data | null

no

null

成功した場合の結果

success.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

success.data

str | null

no

null

処理結果のデータ

warn

dict[str, any] | list[any] | Data | str | bool | null

no

null

警告がある場合の結果

warn.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

error

dict[str, any] | list[any] | Data | str | bool | null

no

null

エラーがある場合の結果

error.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

output_schema

dict[str, any] | null

no

null

スキーマ情報

end

bool | null

no

null

終了フラグ

datasource ( tbl_create ) : cmdbox -m datasource -c tbl_create <Option>

  • Creates a table in the specified datasource.

Option

Type

Multi

Required

Default

Choices

Description

--host <host>

str

required

localhost

Specify the service host of the Redis server.

--port <port>

int

required

6379

Specify the service port of the Redis server.

--password <password>

passwd

required

password

Specify the access password of the Redis server (optional). If omitted, password is used.

--svname <svname>

str

required

cmdbox

Specify the service name of the inference server. If omitted, server is used.

--retry_count <retry_count>

int

3

Specifies the number of reconnections to the Redis server. If less than 0 is specified, reconnection is forever.

--retry_interval <retry_interval>

int

5

Specifies the number of seconds before reconnecting to the Redis server.

--timeout <timeout>

int

60

Specify the maximum waiting time until the server responds.

--dsname <dsname>

str

required

Specify the identifier name of the target datasource.

--schema <schema>

str

Specify the schema name. If omitted, the operation is performed without a schema.

--tblname <tblname>

str

required

Specify the table name to create.

--tblcolumns <tblcolumns>

text

multi

required

Specify column definitions as a JSON array. Each element has the form {"name": "col", "type": "INTEGER", "nullable": true, "primary_key": false, "default": null}.

--if_not_exists <if_not_exists>

bool

False

True | False

Specify whether to suppress an error if the table already exists.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field

Type

Required

Default

Description

success

Data | null

no

null

成功した場合の結果

success.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

success.data

str | null

no

null

処理結果のデータ

warn

dict[str, any] | list[any] | Data | str | bool | null

no

null

警告がある場合の結果

warn.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

error

dict[str, any] | list[any] | Data | str | bool | null

no

null

エラーがある場合の結果

error.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

output_schema

dict[str, any] | null

no

null

スキーマ情報

end

bool | null

no

null

終了フラグ

datasource ( tbl_drop ) : cmdbox -m datasource -c tbl_drop <Option>

  • Drops a table from the specified datasource.

Option

Type

Multi

Required

Default

Choices

Description

--host <host>

str

required

localhost

Specify the service host of the Redis server.

--port <port>

int

required

6379

Specify the service port of the Redis server.

--password <password>

passwd

required

password

Specify the access password of the Redis server (optional). If omitted, password is used.

--svname <svname>

str

required

cmdbox

Specify the service name of the inference server. If omitted, server is used.

--retry_count <retry_count>

int

3

Specifies the number of reconnections to the Redis server. If less than 0 is specified, reconnection is forever.

--retry_interval <retry_interval>

int

5

Specifies the number of seconds before reconnecting to the Redis server.

--timeout <timeout>

int

60

Specify the maximum waiting time until the server responds.

--dsname <dsname>

str

required

Specify the identifier name of the target datasource.

--schema <schema>

str

Specify the schema name. If omitted, the operation is performed without a schema.

--tblname <tblname>

str

required

Specify the table name to drop.

--if_exists <if_exists>

bool

False

True | False

Specify whether to suppress an error if the table does not exist.

Output Schema

This command implements output_schema() returning Result model.

{
  "success": {
    "performance": [
      {
        "key": "string",
        "value": null
      }
    ],
    "data": "string"
  },
  "warn": {},
  "error": {},
  "output_schema": {},
  "end": false
}

Field

Type

Required

Default

Description

success

Data | null

no

null

成功した場合の結果

success.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

success.data

str | null

no

null

処理結果のデータ

warn

dict[str, any] | list[any] | Data | str | bool | null

no

null

警告がある場合の結果

warn.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

error

dict[str, any] | list[any] | Data | str | bool | null

no

null

エラーがある場合の結果

error.performance

list[KeyVal] | null

no

null

パフォーマンス情報のリスト

output_schema

dict[str, any] | null

no

null

スキーマ情報

end

bool | null

no

null

終了フラグ