| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424 |
- #!/usr/local/bin/thrift -java
- // Licensed to Cloudera, Inc. under one
- // or more contributor license agreements. See the NOTICE file
- // distributed with this work for additional information
- // regarding copyright ownership. Cloudera, Inc. licenses this file
- // to you under the Apache License, Version 2.0 (the
- // "License"); you may not use this file except in compliance
- // with the License. You may obtain a copy of the License at
- //
- // http://www.apache.org/licenses/LICENSE-2.0
- //
- // Unless required by applicable law or agreed to in writing, software
- // distributed under the License is distributed on an "AS IS" BASIS,
- // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- // See the License for the specific language governing permissions and
- // limitations under the License.
- #
- # Thrift Service that the MetaStore is built on
- #
- include "fb303.thrift"
- namespace java org.apache.hadoop.hive.metastore.api
- namespace php metastore
- namespace cpp Apache.Hadoop.Hive
- const string DDL_TIME = "transient_lastDdlTime"
- struct Version {
- 1: string version,
- 2: string comments
- }
- struct FieldSchema {
- 1: string name, // name of the field
- 2: string type, // type of the field. primitive types defined above, specify list<TYPE_NAME>, map<TYPE_NAME, TYPE_NAME> for lists & maps
- 3: string comment
- }
- struct Type {
- 1: string name, // one of the types in PrimitiveTypes or CollectionTypes or User defined types
- 2: optional string type1, // object type if the name is 'list' (LIST_TYPE), key type if the name is 'map' (MAP_TYPE)
- 3: optional string type2, // val type if the name is 'map' (MAP_TYPE)
- 4: optional list<FieldSchema> fields // if the name is one of the user defined types
- }
- enum HiveObjectType {
- GLOBAL = 1,
- DATABASE = 2,
- TABLE = 3,
- PARTITION = 4,
- COLUMN = 5,
- }
- enum PrincipalType {
- USER = 1,
- ROLE = 2,
- GROUP = 3,
- }
- struct HiveObjectRef{
- 1: HiveObjectType objectType,
- 2: string dbName,
- 3: string objectName,
- 4: list<string> partValues,
- 5: string columnName,
- }
- struct PrivilegeGrantInfo {
- 1: string privilege,
- 2: i32 createTime,
- 3: string grantor,
- 4: PrincipalType grantorType,
- 5: bool grantOption,
- }
- struct HiveObjectPrivilege {
- 1: HiveObjectRef hiveObject,
- 2: string principalName,
- 3: PrincipalType principalType,
- 4: PrivilegeGrantInfo grantInfo,
- }
- struct PrivilegeBag {
- 1: list<HiveObjectPrivilege> privileges,
- }
- struct PrincipalPrivilegeSet {
- 1: map<string, list<PrivilegeGrantInfo>> userPrivileges, // user name -> privilege grant info
- 2: map<string, list<PrivilegeGrantInfo>> groupPrivileges, // group name -> privilege grant info
- 3: map<string, list<PrivilegeGrantInfo>> rolePrivileges, //role name -> privilege grant info
- }
- struct Role {
- 1: string roleName,
- 2: i32 createTime,
- 3: string ownerName,
- }
- // namespace for tables
- struct Database {
- 1: string name,
- 2: string description,
- 3: string locationUri,
- 4: map<string, string> parameters, // properties associated with the database
- 5: optional PrincipalPrivilegeSet privileges
- }
- // This object holds the information needed by SerDes
- struct SerDeInfo {
- 1: string name, // name of the serde, table name by default
- 2: string serializationLib, // usually the class that implements the extractor & loader
- 3: map<string, string> parameters // initialization parameters
- }
- // sort order of a column (column name along with asc(1)/desc(0))
- struct Order {
- 1: string col, // sort column name
- 2: i32 order // asc(1) or desc(0)
- }
- // this object holds all the information about physical storage of the data belonging to a table
- struct StorageDescriptor {
- 1: list<FieldSchema> cols, // required (refer to types defined above)
- 2: string location, // defaults to <warehouse loc>/<db loc>/tablename
- 3: string inputFormat, // SequenceFileInputFormat (binary) or TextInputFormat` or custom format
- 4: string outputFormat, // SequenceFileOutputFormat (binary) or IgnoreKeyTextOutputFormat or custom format
- 5: bool compressed, // compressed or not
- 6: i32 numBuckets, // this must be specified if there are any dimension columns
- 7: SerDeInfo serdeInfo, // serialization and deserialization information
- 8: list<string> bucketCols, // reducer grouping columns and clustering columns and bucketing columns`
- 9: list<Order> sortCols, // sort order of the data in each bucket
- 10: map<string, string> parameters // any user supplied key value hash
- }
- // table information
- struct Table {
- 1: string tableName, // name of the table
- 2: string dbName, // database name ('default')
- 3: string owner, // owner of this table
- 4: i32 createTime, // creation time of the table
- 5: i32 lastAccessTime, // last access time (usually this will be filled from HDFS and shouldn't be relied on)
- 6: i32 retention, // retention time
- 7: StorageDescriptor sd, // storage descriptor of the table
- 8: list<FieldSchema> partitionKeys, // partition keys of the table. only primitive types are supported
- 9: map<string, string> parameters, // to store comments or any other user level parameters
- 10: string viewOriginalText, // original view text, null for non-view
- 11: string viewExpandedText, // expanded view text, null for non-view
- 12: string tableType, // table type enum, e.g. EXTERNAL_TABLE
- 13: optional PrincipalPrivilegeSet privileges,
- }
- struct Partition {
- 1: list<string> values // string value is converted to appropriate partition key type
- 2: string dbName,
- 3: string tableName,
- 4: i32 createTime,
- 5: i32 lastAccessTime,
- 6: StorageDescriptor sd,
- 7: map<string, string> parameters,
- 8: optional PrincipalPrivilegeSet privileges
- }
- struct Index {
- 1: string indexName, // unique with in the whole database namespace
- 2: string indexHandlerClass, // reserved
- 3: string dbName,
- 4: string origTableName,
- 5: i32 createTime,
- 6: i32 lastAccessTime,
- 7: string indexTableName,
- 8: StorageDescriptor sd,
- 9: map<string, string> parameters,
- 10: bool deferredRebuild
- }
- // schema of the table/query results etc.
- struct Schema {
- // column names, types, comments
- 1: list<FieldSchema> fieldSchemas, // delimiters etc
- 2: map<string, string> properties
- }
- exception MetaException {
- 1: string message
- }
- exception UnknownTableException {
- 1: string message
- }
- exception UnknownDBException {
- 1: string message
- }
- exception AlreadyExistsException {
- 1: string message
- }
- exception InvalidObjectException {
- 1: string message
- }
- exception NoSuchObjectException {
- 1: string message
- }
- exception IndexAlreadyExistsException {
- 1: string message
- }
- exception InvalidOperationException {
- 1: string message
- }
- exception ConfigValSecurityException {
- 1: string message
- }
- /**
- * This interface is live.
- */
- service ThriftHiveMetastore extends fb303.FacebookService
- {
- void create_database(1:Database database) throws(1:AlreadyExistsException o1, 2:InvalidObjectException o2, 3:MetaException o3)
- Database get_database(1:string name) throws(1:NoSuchObjectException o1, 2:MetaException o2)
- void drop_database(1:string name, 2:bool deleteData) throws(1:NoSuchObjectException o1, 2:InvalidOperationException o2, 3:MetaException o3)
- list<string> get_databases(1:string pattern) throws(1:MetaException o1)
- list<string> get_all_databases() throws(1:MetaException o1)
- void alter_database(1:string dbname, 2:Database db) throws(1:MetaException o1, 2:NoSuchObjectException o2)
-
- // returns the type with given name (make seperate calls for the dependent types if needed)
- Type get_type(1:string name) throws(1:MetaException o1, 2:NoSuchObjectException o2)
- bool create_type(1:Type type) throws(1:AlreadyExistsException o1, 2:InvalidObjectException o2, 3:MetaException o3)
- bool drop_type(1:string type) throws(1:MetaException o1, 2:NoSuchObjectException o2)
- map<string, Type> get_type_all(1:string name)
- throws(1:MetaException o2)
- // Gets a list of FieldSchemas describing the columns of a particular table
- list<FieldSchema> get_fields(1: string db_name, 2: string table_name) throws (1: MetaException o1, 2: UnknownTableException o2, 3: UnknownDBException o3),
- // Gets a list of FieldSchemas describing both the columns and the partition keys of a particular table
- list<FieldSchema> get_schema(1: string db_name, 2: string table_name) throws (1: MetaException o1, 2: UnknownTableException o2, 3: UnknownDBException o3)
- // create a Hive table. Following fields must be set
- // tableName
- // database (only 'default' for now until Hive QL supports databases)
- // owner (not needed, but good to have for tracking purposes)
- // sd.cols (list of field schemas)
- // sd.inputFormat (SequenceFileInputFormat (binary like falcon tables or u_full) or TextInputFormat)
- // sd.outputFormat (SequenceFileInputFormat (binary) or TextInputFormat)
- // sd.serdeInfo.serializationLib (SerDe class name eg org.apache.hadoop.hive.serde.simple_meta.MetadataTypedColumnsetSerDe
- // * See notes on DDL_TIME
- void create_table(1:Table tbl) throws(1:AlreadyExistsException o1, 2:InvalidObjectException o2, 3:MetaException o3, 4:NoSuchObjectException o4)
- // drops the table and all the partitions associated with it if the table has partitions
- // delete data (including partitions) if deleteData is set to true
- void drop_table(1:string dbname, 2:string name, 3:bool deleteData)
- throws(1:NoSuchObjectException o1, 2:MetaException o3)
- list<string> get_tables(1: string db_name, 2: string pattern) throws (1: MetaException o1)
- list<string> get_all_tables(1: string db_name) throws (1: MetaException o1)
- Table get_table(1:string dbname, 2:string tbl_name)
- throws (1:MetaException o1, 2:NoSuchObjectException o2)
- // alter table applies to only future partitions not for existing partitions
- // * See notes on DDL_TIME
- void alter_table(1:string dbname, 2:string tbl_name, 3:Table new_tbl)
- throws (1:InvalidOperationException o1, 2:MetaException o2)
- // the following applies to only tables that have partitions
- // * See notes on DDL_TIME
- Partition add_partition(1:Partition new_part)
- throws(1:InvalidObjectException o1, 2:AlreadyExistsException o2, 3:MetaException o3)
- Partition append_partition(1:string db_name, 2:string tbl_name, 3:list<string> part_vals)
- throws (1:InvalidObjectException o1, 2:AlreadyExistsException o2, 3:MetaException o3)
- Partition append_partition_by_name(1:string db_name, 2:string tbl_name, 3:string part_name)
- throws (1:InvalidObjectException o1, 2:AlreadyExistsException o2, 3:MetaException o3)
- bool drop_partition(1:string db_name, 2:string tbl_name, 3:list<string> part_vals, 4:bool deleteData)
- throws(1:NoSuchObjectException o1, 2:MetaException o2)
- bool drop_partition_by_name(1:string db_name, 2:string tbl_name, 3:string part_name, 4:bool deleteData)
- throws(1:NoSuchObjectException o1, 2:MetaException o2)
- Partition get_partition(1:string db_name, 2:string tbl_name, 3:list<string> part_vals)
- throws(1:MetaException o1, 2:NoSuchObjectException o2)
- Partition get_partition_with_auth(1:string db_name, 2:string tbl_name, 3:list<string> part_vals,
- 4: string user_name, 5: list<string> group_names) throws(1:MetaException o1, 2:NoSuchObjectException o2)
- Partition get_partition_by_name(1:string db_name 2:string tbl_name, 3:string part_name)
- throws(1:MetaException o1, 2:NoSuchObjectException o2)
- // returns all the partitions for this table in reverse chronological order.
- // If max parts is given then it will return only that many.
- list<Partition> get_partitions(1:string db_name, 2:string tbl_name, 3:i16 max_parts=-1)
- throws(1:NoSuchObjectException o1, 2:MetaException o2)
- list<Partition> get_partitions_with_auth(1:string db_name, 2:string tbl_name, 3:i16 max_parts=-1,
- 4: string user_name, 5: list<string> group_names) throws(1:NoSuchObjectException o1, 2:MetaException o2)
- list<string> get_partition_names(1:string db_name, 2:string tbl_name, 3:i16 max_parts=-1)
- throws(1:MetaException o2)
-
- // get_partition*_ps methods allow filtering by a partial partition specification,
- // as needed for dynamic partitions. The values that are not restricted should
- // be empty strings. Nulls were considered (instead of "") but caused errors in
- // generated Python code. The size of part_vals may be smaller than the
- // number of partition columns - the unspecified values are considered the same
- // as "".
- list<Partition> get_partitions_ps(1:string db_name 2:string tbl_name
- 3:list<string> part_vals, 4:i16 max_parts=-1)
- throws(1:MetaException o1)
- list<Partition> get_partitions_ps_with_auth(1:string db_name, 2:string tbl_name, 3:list<string> part_vals, 4:i16 max_parts=-1,
- 5: string user_name, 6: list<string> group_names) throws(1:NoSuchObjectException o1, 2:MetaException o2)
-
- list<string> get_partition_names_ps(1:string db_name,
- 2:string tbl_name, 3:list<string> part_vals, 4:i16 max_parts=-1)
- throws(1:MetaException o1)
- // get the partitions matching the given partition filter
- list<Partition> get_partitions_by_filter(1:string db_name 2:string tbl_name
- 3:string filter, 4:i16 max_parts=-1)
- throws(1:MetaException o1, 2:NoSuchObjectException o2)
- // changes the partition to the new partition object. partition is identified from the part values
- // in the new_part
- // * See notes on DDL_TIME
- void alter_partition(1:string db_name, 2:string tbl_name, 3:Partition new_part)
- throws(1:InvalidOperationException o1, 2:MetaException o2)
- // gets the value of the configuration key in the metastore server. returns
- // defaultValue if the key does not exist. if the configuration key does not
- // begin with "hive", "mapred", or "hdfs", a ConfigValSecurityException is
- // thrown.
- string get_config_value(1:string name, 2:string defaultValue)
- throws(1:ConfigValSecurityException o1)
-
- // converts a partition name into a partition values array
- list<string> partition_name_to_vals(1: string part_name)
- throws(1: MetaException o1)
- // converts a partition name into a partition specification (a mapping from
- // the partition cols to the values)
- map<string, string> partition_name_to_spec(1: string part_name)
- throws(1: MetaException o1)
-
- //index
- Index add_index(1:Index new_index, 2: Table index_table)
- throws(1:InvalidObjectException o1, 2:AlreadyExistsException o2, 3:MetaException o3)
- void alter_index(1:string dbname, 2:string base_tbl_name, 3:string idx_name, 4:Index new_idx)
- throws (1:InvalidOperationException o1, 2:MetaException o2)
- bool drop_index_by_name(1:string db_name, 2:string tbl_name, 3:string index_name, 4:bool deleteData)
- throws(1:NoSuchObjectException o1, 2:MetaException o2)
- Index get_index_by_name(1:string db_name 2:string tbl_name, 3:string index_name)
- throws(1:MetaException o1, 2:NoSuchObjectException o2)
- list<Index> get_indexes(1:string db_name, 2:string tbl_name, 3:i16 max_indexes=-1)
- throws(1:NoSuchObjectException o1, 2:MetaException o2)
- list<string> get_index_names(1:string db_name, 2:string tbl_name, 3:i16 max_indexes=-1)
- throws(1:MetaException o2)
- //authorization privileges
-
- bool create_role(1:Role role) throws(1:MetaException o1)
- bool drop_role(1:string role_name) throws(1:MetaException o1)
- list<string> get_role_names() throws(1:MetaException o1)
- bool grant_role(1:string role_name, 2:string principal_name, 3:PrincipalType principal_type,
- 4:string grantor, 5:PrincipalType grantorType, 6:bool grant_option) throws(1:MetaException o1)
- bool revoke_role(1:string role_name, 2:string principal_name, 3:PrincipalType principal_type)
- throws(1:MetaException o1)
- list<Role> list_roles(1:string principal_name, 2:PrincipalType principal_type) throws(1:MetaException o1)
- PrincipalPrivilegeSet get_privilege_set(1:HiveObjectRef hiveObject, 2:string user_name,
- 3: list<string> group_names) throws(1:MetaException o1)
- list<HiveObjectPrivilege> list_privileges(1:string principal_name, 2:PrincipalType principal_type,
- 3: HiveObjectRef hiveObject) throws(1:MetaException o1)
-
- bool grant_privileges(1:PrivilegeBag privileges) throws(1:MetaException o1)
- bool revoke_privileges(1:PrivilegeBag privileges) throws(1:MetaException o1)
-
- //Authentication (delegation token) interfaces
-
- // get metastore server delegation token for use from the map/reduce tasks to authenticate
- // to metastore server
- string get_delegation_token(1:string renewer_kerberos_principal_name) throws (1:MetaException o1)
- // get metastore server delegation token for use from the map/reduce tasks to authenticate
- // to metastore server - this method takes an extra token signature string which is just
- // an identifier to associate with the token - this will be used by the token selector code
- // to pick the right token given the associated identifier.
- string get_delegation_token_with_signature(1:string renewer_kerberos_principal_name,
- 2:string token_signature) throws (1:MetaException o1)
- // method to renew delegation token obtained from metastore server
- i64 renew_delegation_token(1:string token_str_form) throws (1:MetaException o1)
- // method to cancel delegation token obtained from metastore server
- void cancel_delegation_token(1:string token_str_form) throws (1:MetaException o1)
- }
- // * Note about the DDL_TIME: When creating or altering a table or a partition,
- // if the DDL_TIME is not set, the current time will be used.
- // For storing info about archived partitions in parameters
- // Whether the partition is archived
- const string IS_ARCHIVED = "is_archived",
- // The original location of the partition, before archiving. After archiving,
- // this directory will contain the archive. When the partition
- // is dropped, this directory will be deleted
- const string ORIGINAL_LOCATION = "original_location",
- // these should be needed only for backward compatibility with filestore
- const string META_TABLE_COLUMNS = "columns",
- const string META_TABLE_COLUMN_TYPES = "columns.types",
- const string BUCKET_FIELD_NAME = "bucket_field_name",
- const string BUCKET_COUNT = "bucket_count",
- const string FIELD_TO_DIMENSION = "field_to_dimension",
- const string META_TABLE_NAME = "name",
- const string META_TABLE_DB = "db",
- const string META_TABLE_LOCATION = "location",
- const string META_TABLE_SERDE = "serde",
- const string META_TABLE_PARTITION_COLUMNS = "partition_columns",
- const string FILE_INPUT_FORMAT = "file.inputformat",
- const string FILE_OUTPUT_FORMAT = "file.outputformat",
- const string META_TABLE_STORAGE = "storage_handler",
|