CREATE-RESOURCE

Name

CREATE RESOURCE

Description

该语句用于创建资源。仅 root 或 admin 用户可以创建资源。目前支持 Spark, ODBC, S3, JDBC, HDFS, HMS, ES 外部资源。将来其他外部资源可能会加入到 Doris 中使用，如 Spark/GPU 用于查询，HDFS/S3 用于外部存储，MapReduce 用于 ETL 等。

语法：

CREATE [EXTERNAL] RESOURCE "resource_name"
PROPERTIES ("key"="value", ...);

说明：

PROPERTIES 中需要指定资源的类型 "type" = "[spark|odbc_catalog|s3|jdbc|hdfs|hms|es]"。
根据资源类型的不同 PROPERTIES 有所不同，具体见示例。

Example

创建 yarn cluster 模式，名为 spark0 的 Spark 资源。

CREATE EXTERNAL RESOURCE "spark0"
PROPERTIES
(
  "type" = "spark",
  "spark.master" = "yarn",
  "spark.submit.deployMode" = "cluster",
  "spark.jars" = "xxx.jar,yyy.jar",
  "spark.files" = "/tmp/aaa,/tmp/bbb",
  "spark.executor.memory" = "1g",
  "spark.yarn.queue" = "queue0",
  "spark.hadoop.yarn.resourcemanager.address" = "127.0.0.1:9999",
  "spark.hadoop.fs.defaultFS" = "hdfs://127.0.0.1:10000",
  "working_dir" = "hdfs://127.0.0.1:10000/tmp/doris",
  "broker" = "broker0",
  "broker.username" = "user0",
  "broker.password" = "password0"
);

Spark 相关参数如下：

spark.master: 必填，目前支持 yarn，spark://host:port。
spark.submit.deployMode: Spark 程序的部署模式，必填，支持 cluster，client 两种。
spark.hadoop.yarn.resourcemanager.address: master 为 yarn 时必填。
spark.hadoop.fs.defaultFS: master 为 yarn 时必填。
其他参数为可选，参考这里 (opens in a new tab)

Spark 用于 ETL 时需要指定 working_dir 和 broker。说明如下：

working_dir: ETL 使用的目录。spark 作为 ETL 资源使用时必填。例如：hdfs://host:port/tmp/doris。
broker: broker 名字。spark 作为 ETL 资源使用时必填。需要使用ALTER SYSTEM ADD BROKER 命令提前完成配置。
broker.property_key: broker 读取 ETL 生成的中间文件时需要指定的认证信息等。

创建 ODBC resource
```
CREATE EXTERNAL RESOURCE `oracle_odbc`
PROPERTIES (
	"type" = "odbc_catalog",
	"host" = "192.168.0.1",
	"port" = "8086",
	"user" = "test",
	"password" = "test",
	"database" = "test",
	"odbc_type" = "oracle",
	"driver" = "Oracle 19 ODBC driver"
);
```
ODBC 的相关参数如下：
- hosts：外表数据库的 IP 地址
- driver：ODBC 外表的 Driver 名，该名字需要和 be/conf/odbcinst.ini 中的 Driver 名一致。
- odbc_type：外表数据库的类型，当前支持 oracle, mysql, postgresql
- user：外表数据库的用户名
- password：对应用户的密码信息
- charset: 数据库链接的编码信息
- 另外还支持每个 ODBC Driver 实现自定义的参数，参见对应 ODBC Driver 的说明

创建 S3 resource

CREATE RESOURCE "remote_s3"
PROPERTIES
(
   "type" = "s3",
   "s3.endpoint" = "bj.s3.com",
   "s3.region" = "bj",
   "s3.access_key" = "bbb",
   "s3.secret_key" = "aaaa",
   -- the followings are optional
   "s3.connection.maximum" = "50",
   "s3.connection.request.timeout" = "3000",
   "s3.connection.timeout" = "1000"
);

如果 s3 reource 在冷热分层中使用，需要添加额外的字段。

CREATE RESOURCE "remote_s3"
PROPERTIES
(
   "type" = "s3",
   "s3.endpoint" = "bj.s3.com",
   "s3.region" = "bj",
   "s3.access_key" = "bbb",
   "s3.secret_key" = "aaaa",
   -- required by cooldown
   "s3.root.path" = "/path/to/root",
   "s3.bucket" = "test-bucket"
);

S3 相关参数如下：

必需参数
- s3.endpoint：s3 endpoint
- s3.region：s3 region
- s3.root.path：s3 根目录
- s3.access_key：s3 access key
- s3.secret_key：s3 secret key
- s3.bucket：s3 的桶名
可选参数
- s3.connection.maximum：s3 最大连接数量，默认为 50
- s3.connection.request.timeout：s3 请求超时时间，单位毫秒，默认为 3000
- s3.connection.timeout：s3 连接超时时间，单位毫秒，默认为 1000

创建 JDBC resource

CREATE RESOURCE mysql_resource PROPERTIES (
   "type"="jdbc",
   "user"="root",
   "password"="123456",
   "jdbc_url" = "jdbc:mysql://127.0.0.1:3316/doris_test?useSSL=false",
   "driver_url" = "https://doris-community-test-1308700295.cos.ap-hongkong.myqcloud.com/jdbc_driver/mysql-connector-java-8.0.25.jar",
"driver_class" = "com.mysql.cj.jdbc.Driver"
);

JDBC 的相关参数如下：

user：连接数据库使用的用户名
password：连接数据库使用的密码
jdbc_url: 连接到指定数据库的标识符
driver_url: jdbc 驱动包的 url
driver_class: jdbc 驱动类

创建 HDFS resource

CREATE RESOURCE hdfs_resource PROPERTIES (
   "type"="hdfs",
   "hadoop.username"="user",
   "dfs.nameservices" = "my_ha",
   "dfs.ha.namenodes.my_ha" = "my_namenode1, my_namenode2",
   "dfs.namenode.rpc-address.my_ha.my_namenode1" = "nn1_host:rpc_port",
   "dfs.namenode.rpc-address.my_ha.my_namenode2" = "nn2_host:rpc_port",
   "dfs.client.failover.proxy.provider.my_ha" = "org.apache.hadoop.hdfs.server.namenode.ha.ConfiguredFailoverProxyProvider"
);

HDFS 相关参数如下：

fs.defaultFS: namenode 地址和端口
hadoop.username: hdfs 用户名
dfs.nameservices: name service 名称，与 hdfs-site.xml 保持一致
dfs.ha.namenodes.[nameservice ID]: namenode 的 id 列表，与 hdfs-site.xml 保持一致
dfs.namenode.rpc-address.[nameservice ID].[name node ID]: Name node 的 rpc 地址，数量与 namenode 数量相同，与 hdfs-site.xml 保持一致

创建 HMS resource

HMS resource 用于 hms catalog
```
CREATE RESOURCE hms_resource PROPERTIES (
   'type'='hms',
   'hive.metastore.uris' = 'thrift://127.0.0.1:7004',
   'dfs.nameservices'='HANN',
   'dfs.ha.namenodes.HANN'='nn1,nn2',
   'dfs.namenode.rpc-address.HANN.nn1'='nn1_host:rpc_port',
   'dfs.namenode.rpc-address.HANN.nn2'='nn2_host:rpc_port',
   'dfs.client.failover.proxy.provider.HANN'='org.apache.hadoop.hdfs.server.namenode.ha.ConfiguredFailoverProxyProvider'
);
```
HMS 的相关参数如下：
- hive.metastore.uris: hive metastore server 地址可选参数：
- dfs.*: 如果 hive 数据存放在 hdfs，需要添加类似 HDFS resource 的参数，也可以将 hive-site.xml 拷贝到 fe/conf 目录下
- s3.*: 如果 hive 数据存放在 s3，需要添加类似 S3 resource 的参数。如果连接阿里云 Data Lake Formation (opens in a new tab)，可以将 hive-site.xml 拷贝到 fe/conf 目录下
创建 ES resource
```
CREATE RESOURCE es_resource PROPERTIES (
   "type"="es",
   "hosts"="http://127.0.0.1:29200",
   "nodes_discovery"="false",
   "enable_keyword_sniff"="true"
);
```
ES 的相关参数如下：
- hosts: ES 地址，可以是一个或多个，也可以是 ES 的负载均衡地址
- user: ES 用户名
- password: 对应用户的密码信息
- enable_docvalue_scan: 是否开启通过 ES/Lucene 列式存储获取查询字段的值，默认为 true
- enable_keyword_sniff: 是否对 ES 中字符串分词类型 text.fields 进行探测，通过 keyword 进行查询 (默认为 true，设置为 false 会按照分词后的内容匹配)
- nodes_discovery: 是否开启 ES 节点发现，默认为 true，在网络隔离环境下设置为 false，只连接指定节点
- http_ssl_enabled: ES 是否开启 https 访问模式，目前在 fe/be 实现方式为信任所有

Keywords

CREATE, RESOURCE

Best Practice

CREATE-POLICY CREATE-SQL-BLOCK-RULE