# All Classes and Interfaces

Class
Description
AbstractCursor
Base class for implementing a cursor.
AbstractCursor.ArrayAccessor
Accessor that assumes that the underlying value is an ARRAY; corresponds to `Types.ARRAY`.
AbstractCursor.Getter
Gets a value from a particular field of the current record of this cursor.
AbstractHandler<T>
Abstract base class for `Handler`s to extend to inherit functionality common across serialization strategies.
AbstractService
A common base class for `Service` implementations that implement modifications made to response objects.
ArrayFactoryImpl
Implementation of `ArrayImpl.Factory`.
ArrayImpl
Implementation of JDBC `Array`.
ArrayImpl.Factory
Factory that can create a ResultSet or Array based on a stream of values.
ArrayIteratorCursor
Implementation of `Cursor` on top of an `Iterator` that returns an array of `Object` for each row.
AuthenticationType
An enumeration for support types of authentication for the HttpServer.
AvaticaClientRuntimeException
The client-side representation of `AvaticaRuntimeException`.
AvaticaCommonsHttpClientImpl
A common class to invoke HTTP requests against the Avatica server agnostic of the data being sent and received across the wire.
AvaticaConnection
Implementation of JDBC connection for the Avatica framework.
AvaticaConnection.CallableWithoutException<T>
A Callable-like interface but without a "throws Exception".
AvaticaConnection.Trojan
A way to call package-protected methods.
AvaticaDatabaseMetaData
Implementation of `DatabaseMetaData` for the Avatica engine.
AvaticaFactory
Factory for JDBC objects.
AvaticaHttpClient
An interface which defines how requests are sent to the Avatica server.
AvaticaHttpClientFactory
A factory for constructing `AvaticaHttpClient`'s.
AvaticaHttpClientFactoryImpl
Default implementation of `AvaticaHttpClientFactory` which chooses an implementation from a property.
AvaticaHttpClientImpl
A common class to invoke HTTP requests against the Avatica server agnostic of the data being sent and received across the wire.
AvaticaParameter
Metadata for a parameter.
AvaticaPreparedStatement
Implementation of `PreparedStatement` for the Avatica engine.
AvaticaRemoteConnectionConfigImpl
Implementation of `ConnectionConfig` with extra properties specific to Remote Driver.
AvaticaRemoteConnectionProperty
Enumeration of Avatica remote driver's built-in connection properties.
AvaticaResultSet
Implementation of `ResultSet` for the Avatica engine.
AvaticaResultSetMetaData
Implementation of `ResultSetMetaData` for the Avatica framework.
AvaticaRuntimeException
A `RuntimeException` thrown by Avatica with additional contextual information about what happened to cause the Exception.
AvaticaSeverity
An enumeration that denotes the severity of a given unexpected state.
AvaticaSite
A location that a value can be written to or read from.
AvaticaSpecificDatabaseMetaData
Avatica additions to the JDBC `DatabaseMetaData` interface.
AvaticaSqlException
A client-facing `SQLException` which encapsulates errors from the remote Avatica server.
AvaticaStatement
Implementation of `Statement` for the Avatica engine.
AvaticaUtils
Avatica utilities.
Base64
Encodes and decodes to and from Base64 notation.
Base64.InputStream
A `Base64.InputStream` will read data from another `java.io.InputStream`, given in the constructor, and encode/decode to/from Base64 notation on the fly.
Base64.OutputStream
A `Base64.OutputStream` will write data to another `java.io.OutputStream`, given in the constructor, and encode/decode to/from Base64 notation on the fly.
BuiltInConnectionProperty
Enumeration of Avatica's built-in connection properties.
ByteString
Collection of bytes.
Casing
Policy for converting case of identifiers before storing them.
ClientKeytabJaasConf
Javax Configuration class which always returns a configuration for our keytab-based login suitable for callers which are acting as initiators (e.g.
ColumnMetaData
Metadata for a column.
ColumnMetaData.ArrayType
Array type.
ColumnMetaData.AvaticaType
Base class for a column type.
ColumnMetaData.Rep
Description of the type used to internally represent a value.
ColumnMetaData.ScalarType
Scalar type.
ColumnMetaData.StructType
Record type.
CommonsHttpClientPoolCache
Creates and returns a PoolingHttpClientConnectionManager object.
ConnectionConfig
Connection configuration.
ConnectionConfigImpl
Implementation of `ConnectionConfig`.
ConnectionConfigImpl.Converter<T>
Callback to parse a property from string to its native type.
ConnectionConfigImpl.PropEnv
The combination of a property definition and a map of property values.
ConnectionPropertiesImpl
Concrete implementation of `Meta.ConnectionProperties`.
ConnectionProperty
Definition of a property that may be specified on the JDBC connect string.
ConnectionProperty.Type
Data type of property.
ConnectStringParser
ConnectStringParser is a utility class that parses or creates a JDBC connect string according to the OLE DB Connection String Syntax.
Cursor
Interface to an iteration that is similar to, and can easily support, a JDBC `ResultSet`, but is simpler to implement.
Cursor.Accessor
Accessor of a column value.
DateTimeUtils
Utility functions for datetime types: date, time, timestamp.
DateTimeUtils.PrecisionTime
Helper class for `DateTimeUtils.parsePrecisionDateTimeLiteral(java.lang.String, java.lang.String, java.util.TimeZone)`
DoAsAvaticaHttpClient
HTTP client implementation which invokes the wrapped HTTP client in a doAs with the provided Subject.
Driver
Avatica Remote JDBC driver.
Driver.Serialization
Defines the method of message serialization used by the Driver
DriverVersion
Driver version information.
FilteredConstants
A class which, at build time, will have build-specific variables substituted into it.
GSSAuthenticateable
Interface that allows configuration of a GSS credential with SPENGO HTTP authentication.
Handler
Called at various points in the JDBC lifecycle.
Handler<T>
API for text request-response calls to an Avatica server.
Handler.HandlerResponse<T>
Struct that encapsulates the context of the result of a request to Avatica.
Handler.ResultSink
Handler for temporary tables.
HandlerImpl
Implementation of `Handler` that does nothing for each callback.
Helper
Utility methods, mainly concerning error-handling.
HostnameVerificationConfigurable
Deprecated.
HostnameVerificationConfigurable.HostnameVerification
Describes the support hostname verification methods of `AvaticaHttpClient`.
HttpClientPoolConfigurable
Allows a http connection pool to be provided to enable TLS authentication.
InternalProperty
Definitions of properties that drive the behavior of `AvaticaDatabaseMetaData`.
IteratorCursor<E>
Implementation of `Cursor` on top of an `Iterator` that returns a record for each row.
JsonHandler
Implementation of `Handler` that decodes JSON requests, sends them to a `Service`, and encodes the responses into JSON.
JsonService
Implementation of `Service` that encodes requests and responses as JSON.
KerberosConnection
A utility to perform Kerberos logins and renewals.
KeyStoreConfigurable
Deprecated.
ListIteratorCursor
Implementation of `Cursor` on top of an `Iterator` that returns a `List` for each row.
LocalJsonService
Implementation of `Service` that goes to an in-process instance of `Service`.
LocalProtobufService
A Service implementation that performs protocol buffer serialization on request and responses on either side of computing a response from a request to mimic some transport to a server which would normally perform such computation.
LocalService
Implementation of `Service` that talks to a local `Meta`.
MapIteratorCursor
Implementation of `Cursor` on top of an `Iterator` that returns a `Map` for each row.
Meta
Command handler for getting various metadata.
Meta.ConnectionHandle
Connection handle.
Meta.ConnectionProperties
A pojo containing various client-settable `Connection` properties.
Meta.CursorFactory
Information necessary to convert an `Iterable` into a `Cursor`.
Meta.DatabaseProperty
Database property.
Meta.ExecuteBatchResult
Response from a collection of SQL commands or parameter values in a single batch.
Meta.ExecuteResult
Response from execute.
Meta.Factory
Factory to create instances of `Meta`.
Meta.Frame
A collection of rows.
Meta.MetaResultSet
Meta data from which a result set can be constructed.
Meta.Pat
Wrapper to remind API calls that a parameter is a pattern (allows '%' and '_' wildcards, per the JDBC spec) rather than a string to be matched exactly.
Meta.PrepareCallback
API to put a result set into a statement, being careful to enforce thread-safety and not to overwrite existing open result sets.
Meta.Signature
Result of preparing a statement.
Meta.StatementHandle
Statement handle.
Meta.StatementType
Type of statement.
Meta.Style
How logical fields are represented in the objects returned by the iterator.
MetaDataOperation
Identifies an operation from `DatabaseMetaData` which returns a `ResultSet`.
MetaImpl
Basic implementation of `Meta`.
MetaImpl.ColumnNoNulls
Annotation that indicates that a meta field may not contain null values.
MetaImpl.ColumnNullable
Annotation that indicates that a meta field may contain null values.
MetaImpl.ColumnNullableUnknown
Annotation that indicates that it is unknown whether a meta field may contain null values.
MetaImpl.MetaAttribute
Metadata describing an attribute.
MetaImpl.MetaBestRowIdentifier
Metadata describing the best identifier for a row.
MetaImpl.MetaCatalog
Metadata describing a catalog.
MetaImpl.MetaClientInfoProperty
Metadata describing a client info property.
MetaImpl.MetaColumn
Metadata describing a column.
MetaImpl.MetaColumnPrivilege
Metadata describing a column privilege.
MetaImpl.MetaCrossReference
Metadata describing a cross reference.
MetaImpl.MetaExportedKey
Metadata describing an exported key.
MetaImpl.MetaFunction
Metadata describing a function.
MetaImpl.MetaFunctionColumn
Metadata describing a function column.
MetaImpl.MetaImportedKey
Metadata describing an imported key.
MetaImpl.MetaIndexInfo
Metadata describing index info.
MetaImpl.MetaPrimaryKey
Metadata describing a primary key.
MetaImpl.MetaProcedure
Metadata describing a procedure.
MetaImpl.MetaProcedureColumn
Metadata describing a procedure column.
MetaImpl.MetaPseudoColumn
Metadata describing a pseudo column.
MetaImpl.MetaSchema
Metadata describing a schema.
MetaImpl.MetaSuperTable
Metadata describing a super-table.
MetaImpl.MetaSuperType
Metadata describing a super-type.
MetaImpl.MetaTable
Metadata describing a table.
MetaImpl.MetaTablePrivilege
Metadata describing a table privilege.
MetaImpl.MetaTableType
Metadata describing a table type.
MetaImpl.MetaTypeInfo
Metadata describing type info.
MetaImpl.MetaUdt
Metadata describing a user-defined type.
MetaImpl.MetaVersionColumn
Metadata describing a version column.
MetaImpl.Named
An object that has a name.
MetricsHelper
A utility class to encapsulate common logic in use of metrics implementation.
MissingResultsException
An Exception which denotes that a cached Statement is present but has no `ResultSet`.
MockJsonService
Mock implementation of `Service` that encodes its requests and responses as JSON and looks up responses from a pre-defined map.
MockJsonService.Factory
Factory that creates a `MockJsonService`.
MockProtobufService
A mock implementation of ProtobufService for testing.
MockProtobufService.MockProtobufServiceFactory
A factory that instantiates the mock protobuf service.
NoSuchConnectionException
An Exception that denotes that the given Connection is not cached.
NoSuchStatementException
An Exception that denotes that the given Statement is not cached.
PackageMarker
This is a dummy annotation that forces javac to produce output for otherwise empty package-info.java.
PositionedCursor<T>
Abstract implementation of `Cursor` that caches its current row.
ProtobufHandler
Dispatches serialized protocol buffer messages to the provided `Service` by converting them to the POJO Request.
ProtobufMeta
An extension of `Meta` which allows for native processing of calls with the Protobuf API objects instead of the POJOS (to avoid object translation).
ProtobufService
Service implementation that encodes requests and responses as protocol buffers.
ProtobufTranslation
Generic interface to support parsing of serialized protocol buffers between client and server.
ProtobufTranslationImpl
Implementation of `ProtobufTranslationImpl` that translates protobuf requests to POJO requests.
QueryState
A struct used to encapsulate the necessary information to reconstitute a ResultSet in the Avatica server.
QueryState.StateType
An enumeration that represents how a ResultSet was created.
Quoting
Syntax for quoting identifiers in SQL statements.
RecordIteratorCursor<E>
Implementation of `Cursor` on top of an `Iterator` that returns a record for each row.
RemoteProtobufService
ProtobufService implementation that queries against a remote implementation, using protocol buffers as the serialized form.
RemoteService
Implementation of `Service` that translates requests into JSON and sends them to a remote server, usually an HTTP server.
Service
API for request-response calls to an Avatica server.
Service.Base
Base class for request and response.
Service.CatalogsRequest
Request for `Meta.getCatalogs(Meta.ConnectionHandle)`.
Service.CloseConnectionRequest
Request for `Meta.closeConnection(org.apache.calcite.avatica.Meta.ConnectionHandle)`.
Service.CloseConnectionResponse
Response from `Service.CloseConnectionRequest`.
Service.CloseStatementRequest
Request for `Meta.closeStatement(org.apache.calcite.avatica.Meta.StatementHandle)`.
Service.CloseStatementResponse
Response from `Service.CloseStatementRequest`.
Service.ColumnsRequest
Request for `Meta.getColumns(Meta.ConnectionHandle, String, org.apache.calcite.avatica.Meta.Pat, org.apache.calcite.avatica.Meta.Pat, org.apache.calcite.avatica.Meta.Pat)`.
Service.CommitRequest
An RPC request to invoke a commit on a Connection.
Service.CommitResponse
An RPC response from invoking commit on a Connection.
Service.ConnectionSyncRequest
Request for `Meta.connectionSync(Meta.ConnectionHandle, Meta.ConnectionProperties)`.
Service.ConnectionSyncResponse
Response for `Meta.connectionSync(Meta.ConnectionHandle, Meta.ConnectionProperties)`.
Service.CreateStatementRequest
Request for `Meta.createStatement(org.apache.calcite.avatica.Meta.ConnectionHandle)`.
Service.CreateStatementResponse
Response from `Service.CreateStatementRequest`.
Service.DatabasePropertyRequest
Request for `Meta.getDatabaseProperties(Meta.ConnectionHandle)`.
Service.DatabasePropertyResponse
Response for `Meta.getDatabaseProperties(Meta.ConnectionHandle)`.
Service.ErrorResponse
Response for any request that the server failed to successfully perform.
Service.ExecuteBatchRequest
Request object to execute a batch of commands.
Service.ExecuteBatchResponse
Response object for executing a batch of commands.
Service.ExecuteRequest
Request for `Meta.execute(org.apache.calcite.avatica.Meta.StatementHandle, java.util.List<org.apache.calcite.avatica.remote.TypedValue>, long)`.
Service.ExecuteResponse
Response to a `Service.PrepareAndExecuteRequest`.
Service.Factory
Factory that creates a `Service`.
Service.FetchRequest
Request for `Meta.fetch(org.apache.calcite.avatica.Meta.StatementHandle, long, int)`.
Service.FetchResponse
Response from `Service.FetchRequest`.
Service.OpenConnectionRequest
Request for `Meta.openConnection(org.apache.calcite.avatica.Meta.ConnectionHandle, java.util.Map<java.lang.String, java.lang.String>)`.
Service.OpenConnectionResponse
Response from `Service.OpenConnectionRequest`.
Service.PrepareAndExecuteBatchRequest
Request to prepare a statement and execute a series of batch commands in one call.
Service.PrepareAndExecuteRequest
Request for `Meta.prepareAndExecute(Meta.StatementHandle, String, long, int, Meta.PrepareCallback)`.
Service.PrepareRequest
Request for `Meta.prepare(Meta.ConnectionHandle, String, long)`.
Service.PrepareResponse
Response from `Service.PrepareRequest`.
Service.Request
Base class for all service request messages.
Service.Response
Base class for all service response messages.
Service.ResultSetResponse
Response that contains a result set.
Service.RollbackRequest
An RPC request to invoke a rollback on a Connection.
Service.RollbackResponse
An RPC response from invoking rollback on a Connection.
Service.RpcMetadataResponse
Response that includes information about the server that handled an RPC.
Service.SchemasRequest
Request for `Meta.getSchemas(Meta.ConnectionHandle, String, Meta.Pat)`.
Service.SyncResultsRequest
Request for `Service.apply(SyncResultsRequest)`
Service.SyncResultsResponse
Response for `Service.apply(SyncResultsRequest)`.
Service.TablesRequest
Request for `Meta.getTables(Meta.ConnectionHandle, String, org.apache.calcite.avatica.Meta.Pat, org.apache.calcite.avatica.Meta.Pat, java.util.List)`
Service.TableTypesRequest
Request for `Meta.getTableTypes(Meta.ConnectionHandle)`.
Service.TypeInfoRequest
Request for `Meta.getTypeInfo(Meta.ConnectionHandle)`.
Source
Source of data.
Sources
Utilities for `Source`.
Spacer
Efficiently writes strings of spaces.
Spaces
Utilities for creating strings of spaces.
SqlState
SQL error codes.
SqlType
Extends the information in `Types`.
SqlType.Method
Getter methods in `ResultSet`.
StructImpl
Implementation of JDBC `Struct`.
StructImpl.Factory
Factory that can create a result set based on a list of values.
TimeUnit
Enumeration of time units used to construct an interval.
TimeUnitRange
A range of time units.
TrustStoreConfigurable
Deprecated.
TypedValue
Value and type.
UnregisteredDriver
Implementation of JDBC driver that does not register itself.
UnregisteredDriver.JdbcVersion
JDBC version.
Unsafe
Contains methods that call JDK methods that the forbidden APIs checker does not approve of.
UnsynchronizedBuffer
A utility class for reading and writing bytes to byte buffers without synchronization.
UsernamePasswordAuthenticateable
Interface that allows configuration of a username and password with some HTTP authentication.