1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF 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.
*/
package org.apache.spark.sql.hive.client
import java.io.PrintStream
import org.apache.spark.sql.catalyst.analysis._
import org.apache.spark.sql.catalyst.catalog._
import org.apache.spark.sql.catalyst.expressions.Expression
/**
* An externally visible interface to the Hive client. This interface is shared across both the
* internal and external classloaders for a given version of Hive and thus must expose only
* shared classes.
*/
private[hive] trait HiveClient {
/** Returns the Hive Version of this client. */
def version: HiveVersion
/** Returns the configuration for the given key in the current session. */
def getConf(key: String, defaultValue: String): String
/**
* Runs a HiveQL command using Hive, returning the results as a list of strings. Each row will
* result in one string.
*/
def runSqlHive(sql: String): Seq[String]
def setOut(stream: PrintStream): Unit
def setInfo(stream: PrintStream): Unit
def setError(stream: PrintStream): Unit
/** Returns the names of all tables in the given database. */
def listTables(dbName: String): Seq[String]
/** Returns the names of tables in the given database that matches the given pattern. */
def listTables(dbName: String, pattern: String): Seq[String]
/** Sets the name of current database. */
def setCurrentDatabase(databaseName: String): Unit
/** Returns the metadata for specified database, throwing an exception if it doesn't exist */
final def getDatabase(name: String): CatalogDatabase = {
getDatabaseOption(name).getOrElse(throw new NoSuchDatabaseException(name))
}
/** Returns the metadata for a given database, or None if it doesn't exist. */
def getDatabaseOption(name: String): Option[CatalogDatabase]
/** List the names of all the databases that match the specified pattern. */
def listDatabases(pattern: String): Seq[String]
/** Returns the specified table, or throws [[NoSuchTableException]]. */
final def getTable(dbName: String, tableName: String): CatalogTable = {
getTableOption(dbName, tableName).getOrElse(throw new NoSuchTableException(dbName, tableName))
}
/** Returns the metadata for the specified table or None if it doesn't exist. */
def getTableOption(dbName: String, tableName: String): Option[CatalogTable]
/** Creates a view with the given metadata. */
def createView(view: CatalogTable): Unit
/** Updates the given view with new metadata. */
def alertView(view: CatalogTable): Unit
/** Creates a table with the given metadata. */
def createTable(table: CatalogTable, ignoreIfExists: Boolean): Unit
/** Drop the specified table. */
def dropTable(dbName: String, tableName: String, ignoreIfNotExists: Boolean): Unit
/** Alter a table whose name matches the one specified in `table`, assuming it exists. */
final def alterTable(table: CatalogTable): Unit = alterTable(table.identifier.table, table)
/** Updates the given table with new metadata, optionally renaming the table. */
def alterTable(tableName: String, table: CatalogTable): Unit
/** Creates a new database with the given name. */
def createDatabase(database: CatalogDatabase, ignoreIfExists: Boolean): Unit
/**
* Drop the specified database, if it exists.
*
* @param name database to drop
* @param ignoreIfNotExists if true, do not throw error if the database does not exist
* @param cascade whether to remove all associated objects such as tables and functions
*/
def dropDatabase(name: String, ignoreIfNotExists: Boolean, cascade: Boolean): Unit
/**
* Alter a database whose name matches the one specified in `database`, assuming it exists.
*/
def alterDatabase(database: CatalogDatabase): Unit
/**
* Create one or many partitions in the given table.
*/
def createPartitions(
db: String,
table: String,
parts: Seq[CatalogTablePartition],
ignoreIfExists: Boolean): Unit
/**
* Drop one or many partitions in the given table, assuming they exist.
*/
def dropPartitions(
db: String,
table: String,
specs: Seq[ExternalCatalog.TablePartitionSpec],
ignoreIfNotExists: Boolean): Unit
/**
* Rename one or many existing table partitions, assuming they exist.
*/
def renamePartitions(
db: String,
table: String,
specs: Seq[ExternalCatalog.TablePartitionSpec],
newSpecs: Seq[ExternalCatalog.TablePartitionSpec]): Unit
/**
* Alter one or more table partitions whose specs match the ones specified in `newParts`,
* assuming the partitions exist.
*/
def alterPartitions(
db: String,
table: String,
newParts: Seq[CatalogTablePartition]): Unit
/** Returns the specified partition, or throws [[NoSuchPartitionException]]. */
final def getPartition(
dbName: String,
tableName: String,
spec: ExternalCatalog.TablePartitionSpec): CatalogTablePartition = {
getPartitionOption(dbName, tableName, spec).getOrElse {
throw new NoSuchPartitionException(dbName, tableName, spec)
}
}
/** Returns the specified partition or None if it does not exist. */
final def getPartitionOption(
db: String,
table: String,
spec: ExternalCatalog.TablePartitionSpec): Option[CatalogTablePartition] = {
getPartitionOption(getTable(db, table), spec)
}
/** Returns the specified partition or None if it does not exist. */
def getPartitionOption(
table: CatalogTable,
spec: ExternalCatalog.TablePartitionSpec): Option[CatalogTablePartition]
/** Returns all partitions for the given table. */
final def getAllPartitions(db: String, table: String): Seq[CatalogTablePartition] = {
getAllPartitions(getTable(db, table))
}
/** Returns all partitions for the given table. */
def getAllPartitions(table: CatalogTable): Seq[CatalogTablePartition]
/** Returns partitions filtered by predicates for the given table. */
def getPartitionsByFilter(
table: CatalogTable,
predicates: Seq[Expression]): Seq[CatalogTablePartition]
/** Loads a static partition into an existing table. */
def loadPartition(
loadPath: String,
tableName: String,
partSpec: java.util.LinkedHashMap[String, String], // Hive relies on LinkedHashMap ordering
replace: Boolean,
holdDDLTime: Boolean,
inheritTableSpecs: Boolean,
isSkewedStoreAsSubdir: Boolean): Unit
/** Loads data into an existing table. */
def loadTable(
loadPath: String, // TODO URI
tableName: String,
replace: Boolean,
holdDDLTime: Boolean): Unit
/** Loads new dynamic partitions into an existing table. */
def loadDynamicPartitions(
loadPath: String,
tableName: String,
partSpec: java.util.LinkedHashMap[String, String], // Hive relies on LinkedHashMap ordering
replace: Boolean,
numDP: Int,
holdDDLTime: Boolean,
listBucketingEnabled: Boolean): Unit
/** Create a function in an existing database. */
def createFunction(db: String, func: CatalogFunction): Unit
/** Drop an existing function an the database. */
def dropFunction(db: String, name: String): Unit
/** Rename an existing function in the database. */
def renameFunction(db: String, oldName: String, newName: String): Unit
/** Alter a function whose name matches the one specified in `func`, assuming it exists. */
def alterFunction(db: String, func: CatalogFunction): Unit
/** Return an existing function in the database, assuming it exists. */
final def getFunction(db: String, name: String): CatalogFunction = {
getFunctionOption(db, name).getOrElse(throw new NoSuchFunctionException(db, name))
}
/** Return an existing function in the database, or None if it doesn't exist. */
def getFunctionOption(db: String, name: String): Option[CatalogFunction]
/** Return whether a function exists in the specified database. */
final def functionExists(db: String, name: String): Boolean = {
getFunctionOption(db, name).isDefined
}
/** Return the names of all functions that match the given pattern in the database. */
def listFunctions(db: String, pattern: String): Seq[String]
/** Add a jar into class loader */
def addJar(path: String): Unit
/** Return a [[HiveClient]] as new session, that will share the class loader and Hive client */
def newSession(): HiveClient
/** Run a function within Hive state (SessionState, HiveConf, Hive client and class loader) */
def withHiveState[A](f: => A): A
/** Used for testing only. Removes all metadata from this instance of Hive. */
def reset(): Unit
}
|
