DolphinDB Catalog 使用教程

使用 createCatalog 函数创建一个名为 trading 的 catalog。

createCatalog("trading")

catalog 的名称必须由大小写字母开头，且只能由大小写字母、数字、下划线(_)组成。如：catalog, catalog1, catalog_example, catalog1_example。使用 catalog 时可以大小写不敏感。

使用 USE CATALOG 语句，切换到该 catalog。执行该操作后，若不指定具体的 catalog 则默认优先使用当前的 catalog 即 trading。

use catalog trading;

使用 create database 语句在 trading 中创建一个名为 stock、按照 VALUE 分区、存储引擎为 OLAP 的 schema。

create database stock partitioned by VALUE(1..10), engine='OLAP'

schema 的名称约束与 database 相同，必须由大小写字母开头，且只能由大小写字母、数字、下划线(_)组成，如：schema1 , schema1_example。且使用 schema 时可以大小写不敏感。

由于上一步中使用 use 指定了当前 catalog，所以上述语句中的 stock 等价为 trading.stock。如未使用 use 语句指定 catalog 却直接输入 schema 的名称，则会报错：”The catalog doesn't exist.“

在后续使用其他 SQL 语句时，如 create table，select 等，都遵循上述查找规则。

如果想要将一个已存在的数据库插入到 catalog 中，可以使用 createSchema 函数。

下例中，通过 database 函数创建 *dfs://db1 *之后，再向 trading 中插入路径为 dfs://db1 名为 stock2 的 schema。

database(directory="dfs://db1", partitionType=RANGE, partitionScheme=0 5 10) //通过database函数创建的db1
createSchema("trading", "dfs://db1", "stock2") // 通过createSchema函数创建对应的schema

在该 schema 中创建一张表：

create table stock.quote (
     id INT,
     date DATE[comment="time_col", compress="delta"],
     value DOUBLE,
 )
 partitioned by id

由于已设置当前 catalog，此处 stock.quote 等价为 trading.stock.quote。

注意：如果想查看 catalog 以及 schena 的相关操作变动，可以从控制节点日志中寻找对应的 Audit Log。Audit Log 包含具体操作的 catalog，schema，操作者等信息。格式如下：

ACL Audit: function createSchema [catalog=trading,dbUrl=dfs://db1,schema=stock2], called by user [xxx]

如果想要查看当前 session 默认的 catalog，可以使用 getCurrentCatalog 函数。

use catalog trading;
getCurrentCatalog() // => "trading"

use catalog trading2;
getCurrentCatalog() // => "trading2"

可以使用 renameCatalog、renameSchema 函数对 catalog 或 schema 重命名。

例 1 将 trading 重命名为 trading2

renameCatalog("trading", "trading2") 
getAllCatalogs() // => ["trading2"]

例 2 将 trading 中的 stock 重命名为 stock1

renameSchema("trading", "stock", "stock1") 
exec schema from getSchemaByCatalog("trading") // => ["stock1"]

在上面的例子中，我们使用 create database 语句在 catalog *trading *创建了一个 stock 的 schema：

use catalog trading;
create database stock partitioned by VALUE(1..10), engine='OLAP'

使用 create database 语句创建的 schema，其 *dbUrl *的默认格式为”dfs://{创建时间戳}”。可通过 getSchemaByCatalog 进行查看。

getSchemaByCatalog("trading")

返回结果：

注意，dbUrl 是全局唯一且不变的，即使 schema 或者 catalog 进行重命名操作，dbUrl 也不会变。