Catalog
Catalog
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
CatalogId |
String |
1344371 |
数据库分类命名空间，默认填写主账号Uid |
CreateTime |
Integer |
1608863962 |
创建时间，Unix时间戳秒数 |
ColumnStatistics
ColumnStatisticsList
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
ColumnStatisticsDesc |
字段统计描述信息 |
||
ColumnStatisticsObjList |
Array of ColumnStatisticsObj |
字段统计信息 |
|
Engine |
String |
Engine |
|
IsStatsCompliant |
Boolean |
false |
IsStatsCompliant |
ColumnStatisticsDesc
ColumnStatisticsDesc
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
LastAnalyzedTime |
Long |
最近一次分析时间 |
|
PartitionName |
String |
分区名称 |
ColumnStatisticsObj
ColumnStatisticsObj
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
ColumnName |
String |
col1 |
字段名称 |
ColumnType |
String |
int |
字段类型，包括array bigint binary boolean char date decimal double float int interval map set smallint string struct timestamp tinyint union varchar |
ColumnStatisticsData |
Object |
字段统计 |
|
StatisticsData |
String |
{"numNulls":0,"numTrues":1,"numFalses":5} |
具体的统计结果 |
StatisticsType |
String |
BOOLEAN_STATS |
统计类型，包括BOOLEAN_STATS，LONG_STATS，DOUBLE_STATS，STRING_STATS，BINARY_STATS，DECIMAL_STATS，DATE_STATS |
Database
数据库对象
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
CreateTime |
Integer |
1608707407 |
创建时间，Unix时间戳秒数 |
Description |
String |
this is a hive database |
元数据库描述文本 |
LocationUri |
String |
/hdfs/hivedb/data |
元数据库保存路径，例如HDFS路径 |
Name |
String |
database_test |
元数据库名称 |
OwnerName |
String |
zhangsan |
负责人名称 |
OwnerType |
String |
USER |
负责人类型，填USER或ROLE或GROUP |
Parameters |
定义数据库的参数和属性的键值对 |
||
Privileges |
权限，非必填 |
||
UpdateTime |
Integer |
1608707407 |
更新时间，Unix时间戳秒数 |
DatabaseInput
数据库对象
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
Description |
String |
this is a hive database |
元数据库描述文本 |
LocationUri |
String |
/hdfs/hivedb/data |
元数据库保存路径，例如可填写HDFS路径 |
Name |
String |
name |
元数据库名称，校验长度128，不支持除下划线以外的特殊字符 |
OwnerName |
String |
zhangsan |
负责人名称 |
OwnerType |
String |
USER |
负责人类型，填USER或ROLE或GROUP |
Parameters |
定义数据库的参数和属性的键值对 |
||
Privileges |
权限，非必填 |
ErrorDetail
ErrorDetail
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
Code |
String |
401 |
错误码 |
Message |
String |
auth failed |
错误信息 |
FieldSchema
FieldSchema
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
Comment |
String |
comment_day |
字段的文本注释 |
Name |
String |
day |
字段名称 |
Parameters |
字段关联属性的键值对 |
||
Type |
String |
int |
字段类型，包括array bigint binary boolean char date decimal double float int interval map set smallint string struct timestamp tinyint union varchar |
Function
函数
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
CatalogId |
String |
1344371 |
数据库分类命名空间，默认填写主账号Uid |
ClassName |
String |
com.xxx.xxxxFunction |
包含了函数实现的Java类名 |
CreateTime |
Integer |
1608863962 |
创建时间，Unix时间戳秒数 |
DatabaseName |
String |
database_test |
元数据库名称 |
FunctionName |
String |
function1 |
函数名称 |
FunctionType |
String |
JAVA |
函数类型， 目前支持的枚举为JAVA |
OwnerName |
String |
zhangsan |
负责人名称 |
OwnerType |
String |
USER |
负责人类型，填USER或ROLE或GROUP |
ResourceUri |
Array of ResourceUri |
函数的资源URI |
|
UpdateTime |
Integer |
1608863962 |
更新时间，Unix时间戳秒数 |
FunctionInput
函数
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
ClassName |
String |
com.xxx.xxxxFunction |
包含了函数实现的Java类名 |
FunctionName |
String |
function1 |
函数名称 |
FunctionType |
String |
JAVA |
函数类型， 目前支持的枚举为JAVA |
OwnerName |
String |
zhangsan |
负责人名称 |
OwnerType |
String |
USER |
负责人类型，填USER或ROLE或GROUP |
ResourceUri |
Array of ResourceUri |
函数的资源URI |
ListFieldSchema
ListFieldSchema数组
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
FieldSchema |
表字段的定义 |
ListResourceUri
资源URI列表
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
ResourceType |
String |
JAR |
资源类型，枚举包括JAR FILE ARCHIVE |
Uri |
String |
hdfs:///tmp/jar1.jar |
URI资源地址 |
ListString
值
参数名称 |
类型 |
示例值 |
描述 |
|---|
LockObj
LockObj
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
CatalogId |
String |
1344371 |
数据库分类命名空间，默认填写主账号Uid |
DatabaseName |
String |
database_test |
元数据库名称 |
PartitionName |
String |
dt |
分区名称，非必填 |
TableName |
String |
test_table |
元数据表名称 |
LockStatus
LockStatus
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
LockId |
Long |
1 |
锁唯一ID |
LockState |
String |
ACQUIRED |
锁状态，ACQUIRED/NOT_ACQUIRED |
Order
Order
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
Col |
String |
col1 |
字段名称 |
Order |
Integer |
1 |
1表示升序排列，0表示降序排列 |
Parameters
Parameters
参数名称 |
类型 |
示例值 |
描述 |
|---|
Partition
Partition
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
CreateTime |
Integer |
1608730999 |
创建时间，Unix时间戳秒数 |
DatabaseName |
String |
database_test |
元数据库名称 |
LastAccessTime |
Integer |
1608730999 |
上一次访问分区的时间 |
LastAnalyzedTime |
Integer |
1608730999 |
上一次执行统计运算的时间 |
Parameters |
Map |
分区有关的键值对参数 |
|
Privileges |
权限配置，可以空 |
||
Sd |
存储描述符 |
||
TableName |
String |
test_table_20201223 |
元数据表名称 |
Values |
Array of String |
part1 |
分区的值 |
PartitionInput
Partition
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
DatabaseName |
String |
database_test |
元数据库名称 |
LastAccessTime |
Integer |
1608730999 |
上一次访问分区的时间，Unix时间戳秒数 |
LastAnalyzedTime |
Integer |
1608730999 |
上一次执行统计运算的时间，Unix时间戳秒数 |
Parameters |
Map |
分区有关的键值对参数 |
|
Privileges |
权限配置，可以空 |
||
Sd |
存储描述符 |
||
TableName |
String |
test_table_20201223 |
元数据表名称 |
Values |
Array of String |
part1 |
分区的值 |
PartitionValueList
PartitionValueList
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
Values |
分区值 |
PrincipalPrivilegeSet
PrincipalPrivilegeSet Object
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
GroupPrivileges |
GroupPrivileges |
||
RolePrivileges |
RolePrivileges |
||
UserPrivileges |
UserPrivileges |
PrivilegeGrantInfo
PrivilegeGrantInfo Object
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
CreateTime |
Integer |
1606226844 |
创建时间，Unix时间戳秒数 |
GrantOption |
Boolean |
true |
GrantOption |
Grantor |
String |
Grantor |
Grantor |
GrantorType |
String |
GrantorType |
GrantorType |
Privilege |
String |
Privilege |
Privilege |
Privileges
Privileges Object
参数名称 |
类型 |
示例值 |
描述 |
|---|
ResourceUri
ResourceUri
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
ResourceType |
String |
JAR |
资源类型，枚举包括JAR FILE ARCHIVE |
Uri |
String |
hdfs:///tmp/jar1.jar |
URI资源地址 |
SerDeInfo
SerDeInfo
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
Name |
String |
name |
名称 |
SerializationLib |
String |
org.apache.hadoop.hive.serde2.OpenCSVSerde |
SerDe的实现类 |
SkewedInfo
SkewedInfo
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
SkewedColNames |
Array of String |
col1 |
倾斜字段 |
SkewedColValueLocationMaps |
Map |
倾斜值和字段的映射Map |
|
SkewedColValues |
Array of Array |
倾斜值 |
StorageDescriptor
StorageDescriptor
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
BucketCols |
分桶的字段的数组 |
||
Cols |
Array of FieldSchema |
表中的所有字段 |
|
Compressed |
Boolean |
false |
是否启用压缩 |
InputFormat |
String |
org.apache.hadoop.hive.ql.io.avro.AvroContainerInputFormat |
输入格式，具体参见CreateTable的API解释 |
Location |
String |
file:///tmp/table |
表的物理位置 |
NumBuckets |
Integer |
10 |
分桶的数量，如果设置了BucketCols则必填 |
OutputFormat |
String |
org.apache.hadoop.hive.ql.io.avro.AvroContainerOutputFormat |
输出格式，具体参见CreateTable的API解释 |
Parameters |
Map |
键值对的映射数组 |
|
SerDeInfo |
序列化/反序列化信息 |
||
SkewedInfo |
一个字段中的大量重复值（数据倾斜）的设定 |
||
SortCols |
Array of Order |
排序字段设定 |
|
StoredAsSubDirectories |
Boolean |
false |
表数据是否存储在子目录中 |
Table
Table
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
Cascade |
Boolean |
false |
是否允许级联删除 |
CreateTime |
Integer |
1608707407 |
创建时间，Unix时间戳秒数 |
CreatedBy |
String |
zhangsan |
创建者名称 |
DatabaseName |
String |
database_test |
元数据库名称 |
LastAccessTime |
Integer |
1608707407 |
上一次访问这个table的时间戳 |
LastAnalyzedTime |
Integer |
1608707407 |
上一次做列级别的统计信息计算的时间戳 |
Owner |
String |
zhangsan |
负责人名称 |
OwnerType |
String |
USER |
负责人类型，填USER或ROLE或GROUP |
Parameters |
与表相关的属性键值对的定义 |
||
PartitionKeys |
分区表的列的列表 |
||
Privileges |
权限设置 |
||
Retention |
Integer |
30000 |
该表的保留时间 |
RewriteEnabled |
Boolean |
true |
视图是否可被重写的query使用 |
Sd |
存储描述符，包含有关此表的物理存储信息 |
||
TableName |
String |
table_name |
表名称 |
TableType |
String |
MANAGED_TABLE |
元数据表的类型：例如MANAGED_TABLE，EXTERNAL_TABLE，VIRTUAL_VIEW，INDEX_TABLE，MATERIALIZED_VIEW |
Temporary |
Boolean |
false |
是否临时表 |
UpdateTime |
Integer |
1608707407 |
更新时间，Unix时间戳秒数 |
ViewExpandedText |
String |
'' |
视图的详细语句 |
ViewOriginalText |
String |
'' |
视图的原始语句 |
TableError
TableError
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
ErrorDetail |
错误详细信息 |
||
TableName |
String |
出现错误的表名 |
TableInput
Table
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
Cascade |
Boolean |
false |
是否级联删除 |
CreatedBy |
String |
zhangsan |
创建者名称 |
DatabaseName |
String |
database_test |
元数据库名称 |
LastAccessTime |
Integer |
1608707407 |
上一次访问这个table的时间戳 |
LastAnalyzedTime |
Integer |
1608707407 |
上一次做列级别的统计信息计算的时间戳 |
Owner |
String |
zhangsan |
负责人名称 |
OwnerType |
String |
USER |
负责人类型，填USER或ROLE或GROUP |
Parameters |
与表相关的属性键值对的定义 |
||
PartitionKeys |
分区表的列的列表。 仅支持基本类型作为分区键。如果未指定任何partitionKeys，需要将partitionKeys的值设置为空列表 |
||
Privileges |
权限设置，可以为空对象 |
||
Retention |
Integer |
30000 |
该表的保留时间 |
RewriteEnabled |
Boolean |
true |
视图是否可被重写的query使用 |
Sd |
存储描述符，包含有关此表的物理存储信息 |
||
TableName |
String |
table_name |
表名称 |
TableType |
String |
MANAGED_TABLE |
元数据表的类型：例如MANAGED_TABLE，EXTERNAL_TABLE，VIRTUAL_VIEW，INDEX_TABLE，MATERIALIZED_VIEW |
Temporary |
Boolean |
false |
是否临时表 |
ViewExpandedText |
String |
'' |
视图的详细语句 |
ViewOriginalText |
String |
'' |
视图的原始语句 |
TableVersion
新增表版本的结构
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
Table |
元数据表详情 |
||
VersionId |
Integer |
版本号 |
UpdateTablePartitionColumnStatisticsRequest
UpdateTableColumnStatistics
参数名称 |
类型 |
示例值 |
描述 |
|---|---|---|---|
CatalogId |
String |
1344371 |
数据库分类命名空间，默认填写主账号Uid |
ColumnStatisticsList |
Array of ColumnStatistics |
字段统计信息列表 |
|
DatabaseName |
String |
database_test |
元数据库名称 |
Engine |
String |
引擎 |
|
TableName |
String |
元数据表的名称 |
|
ValidWriteIdList |
String |
ValidWriteIdList，暂不支持，可空 |
|
WriteId |
String |
WriteId，暂不支持，可空 |
|
IsStatsCompliant |
Boolean |
true |
IsStatsCompliant |