Index (VoltDB Server APIs)

A B C D E F G H I L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

abortProcedure(String) - Method in class org.voltdb.VoltCompoundProcedure: Indicates that processing of this compound procedure is being abandoned.
AbstractImporter - Class in org.voltdb.importer: Abstract class that must be extended to create custom importers in VoltDB server.
AbstractImporterFactory - Class in org.voltdb.importer: Factory class that importer bundles should extend to make the importer available for use within VoltDB server.
AbstractImporterFactory() - Constructor for class org.voltdb.importer.AbstractImporterFactory
acceptsArray(Class<?>) - Method in enum class org.voltdb.VoltType: Most VoltTypes are not compatible with an array-typed value.
Action - Class in org.voltdb.task: Class which defines an action to be taken as well as a callback to be invoked when that action has been performed.
ActionGenerator - Interface in org.voltdb.task: Interface which generates actions to be be performed as part of a task on a schedule
ActionResult - Interface in org.voltdb.task: The result of executing an Action which was produed by either an IntervalGenerator or ActionScheduler
ActionScheduler - Interface in org.voltdb.task: Interface which generates actions to be performed as well as calculating the interval that should elapse before the action is performed.
ActionType - Enum Class in org.voltdb.task: Enum used to describe the type of the Action.
add(VoltTableRow) - Method in class org.voltdb.VoltTable: Append a row from another VoltTable to this VoltTable instance.
addErrorMessage(String) - Method in class org.voltdb.utils.CompoundErrors: Add a new error message to the set of errors being returned from this validation
addRow(Object...) - Method in class org.voltdb.VoltTable: Append a new row to the table using the supplied column values.
addTable(VoltTable) - Method in class org.voltdb.VoltTable: Add all rows from other into this VoltTable.
addTables(Collection<VoltTable>) - Method in class org.voltdb.VoltTable: Add all rows from tables into this VoltTable.
addTableWithExtraColumns(VoltTable) - Method in class org.voltdb.VoltTable: Adds a table with extra columns, based on another provided table.
addTableWithLessColumns(VoltTable) - Method in class org.voltdb.VoltTable: Adds a table with fewer columns, based on another provided table.
advanceRow() - Method in class org.voltdb.VoltTableRow: Makes the next row active so calls to getXXX() will return values from the current record.
advanceToRow(int) - Method in class org.voltdb.VoltTableRow: Advance to a specific row so calls to getXXX() will return values from the current record.
asApproximateJavaDate() - Method in class org.voltdb.types.TimestampType: Retrieve a copy of the approximate Java date.
asDateType() - Method in class org.voltdb.types.TimestampType: Retrieve a properly typed copy of the VoltDB Date for the VoltDB TimeStamp's year, month and day values.
asExactJavaDate() - Method in class org.voltdb.types.TimestampType: Retrieve a copy of the Java date for a TimeStamp with millisecond granularity.
asExactJavaSqlDate() - Method in class org.voltdb.types.TimestampType: Retrieve a properly typed copy of the Java date for a TimeStamp with millisecond granularity.
asJavaTimestamp() - Method in class org.voltdb.types.TimestampType: Retrieve a properly typed copy of the Java Timestamp for the VoltDB TimeStamp.
asScalarLong() - Method in class org.voltdb.VoltTable: Tables containing a single row and a single integer column can be read using this convenience method.

B

BIGINT - Enum constant in enum class org.voltdb.VoltType: 8-byte signed 2s-complement long.
BOOLEAN - Enum constant in enum class org.voltdb.VoltType: Boolean type.
build() - Method in class org.voltdb.VoltCompoundProcedure.StageListBuilder: Finalizes the list of stages, and sets it up ready for execution.
buildReusableDependenyResult() - Method in class org.voltdb.VoltTable: Builds a dependency response that can be reused.
bytesToValue(byte[]) - Method in enum class org.voltdb.VoltType: Converts a byte array with type back to the original partition value.

C

callback(long, TimeUnit, Function<ActionResult, ScheduledAction>) - Static method in class org.voltdb.task.ScheduledAction: Create a ScheduledAction which causes the callback to be invoked after interval .
callback(Function<ActionResult, Action>) - Static method in class org.voltdb.task.Action: Create an Action which causes the callback to be invoked.
CALLBACK - Enum constant in enum class org.voltdb.task.ActionType: Schedule the provided callback to be invoked
callProcedure(Invocation, ProcedureCallback) - Method in class org.voltdb.importer.AbstractImporter: This should be used importer implementations to execute a stored procedure.
canExactlyRepresentAnyValueOf(VoltType) - Method in enum class org.voltdb.VoltType: Indicate whether a value can be assigned to this type without loss of range or precision, important for index key and partition key initialization.
classFromByteValue(byte) - Static method in enum class org.voltdb.VoltType: Return the java class that is matched to the given value.
classFromType() - Method in enum class org.voltdb.VoltType: Return the java class that is matched to a given VoltType.
clearRowData() - Method in class org.voltdb.VoltTable: Delete all row data.
clone() - Method in class org.voltdb.VoltTable.ColumnInfo: Basically just suppress CloneNotSupportedException.
clone(int) - Method in class org.voltdb.VoltTable: Generates a duplicate of a table including the column schema.
cloneRow() - Method in class org.voltdb.VoltTable: Get a new VoltTableRow instance with identical position as this table.
cloneRow() - Method in class org.voltdb.VoltTableRow: Clone a row.
ColumnInfo(String, VoltType) - Constructor for class org.voltdb.VoltTable.ColumnInfo: Construct an immutable ColumnInfo instance.
compareTo(TimestampType) - Method in class org.voltdb.types.TimestampType: CompareTo - to mimic Java Date
completeProcedure(long) - Method in class org.voltdb.VoltCompoundProcedure: All processing of this compound procedure is now complete.
completeProcedure(VoltTable) - Method in class org.voltdb.VoltCompoundProcedure: All processing of this compound procedure is now complete.
completeProcedure(VoltTable[]) - Method in class org.voltdb.VoltCompoundProcedure: All processing of this compound procedure is now complete.
CompoundErrors - Class in org.voltdb.utils: Helper that can be used to collect multiple errors that are encountered, e.g.
CompoundErrors() - Constructor for class org.voltdb.utils.CompoundErrors
CompoundProcAbortException(String) - Constructor for exception org.voltdb.VoltCompoundProcedure.CompoundProcAbortException: Construct a CompoundProcAbortException with a specified detail message.
CompoundProcAbortException(String, Throwable) - Constructor for exception org.voltdb.VoltCompoundProcedure.CompoundProcAbortException: Construct a CompoundProcAbortException with a specified detail message and a specified cause.
CompoundProcAbortException(Throwable) - Constructor for exception org.voltdb.VoltCompoundProcedure.CompoundProcAbortException: Construct a CompoundProcAbortException with a specified cause, and a detail message copied from the cause (if such exists).
configPartitionCount(int) - Method in class org.voltdb.InProcessVoltDBServer: Set the number of partitions the single VoltDB server will use.
configPathToLicense(String) - Method in class org.voltdb.InProcessVoltDBServer: When using enterprise or pro edition, specify a path to the license needed.
convertToHeapBuffer() - Method in class org.voltdb.VoltTable: Converts the allocated direct buffer to a heap buffer, if necessary,
createImporter(int, ImporterConfig) - Method in class org.voltdb.importer.AbstractImporterFactory: Method that is used by the importer framework classes to create an importer instance and wire it correctly for use within the server.
createImporterConfigurations(Properties, FormatterBuilder) - Method in class org.voltdb.importer.AbstractImporterFactory: From a given set of properties, creates ImporterConfig for every resource ID configured.

D

DATABASE - Enum constant in enum class org.voltdb.task.TaskScope: Database scope
DATE - Enum constant in enum class org.voltdb.VoltType: 4-byte long value representing DATE
debug(Throwable, String, Object...) - Method in class org.voltdb.importer.AbstractImporter: Log a DEBUG level log message.
DECIMAL - Enum constant in enum class org.voltdb.VoltType: Fixed precision=38, scale=12 storing sign and null-status in a preceding byte
decodeValue(ByteBuffer) - Method in enum class org.voltdb.VoltType: Decode a on object of this type from buffer
DEFAULT_COLUMN_SIZE - Static variable in class org.voltdb.VoltType.LengthRange: Default size of a column
DEFAULT_LENGTH - Static variable in class org.voltdb.types.GeographyValue: The default length (in bytes) for a column with type GEOGRAPHY, if no length is specified.
defaultLengthForVariableLengthType() - Method in enum class org.voltdb.VoltType: The size specifier for columns with a variable-length type is optional in a CREATE TABLE or ALTER TABLE statement.

E

equals(Object) - Method in class org.voltdb.types.GeographyPointValue: Compare this point with another object.
equals(Object) - Method in class org.voltdb.types.GeographyValue
equals(Object) - Method in class org.voltdb.types.TimestampType: Equality.
equals(Object) - Method in class org.voltdb.VoltTable.ColumnInfo
equals(Object) - Method in class org.voltdb.VoltTable: Deprecated.
Exists for unit testing, but probably shouldn't be called.
error(String) - Static method in class org.voltdb.task.Action: Create an Action which indicates that an unrecoverable error has occurred and the scheduler must exit.
error(String) - Static method in class org.voltdb.task.ScheduledAction: Create a ScheduledAction which indicates that an unrecoverable error has occurred and the scheduler must exit.
error(Throwable, String, Object...) - Method in class org.voltdb.importer.AbstractImporter: Log a ERROR level log message.
ERROR - Enum constant in enum class org.voltdb.task.ActionType: Unexpected error occurred within the scheduler and additional procedures will not be scheduled
exit(String) - Static method in class org.voltdb.task.Action: Create an Action which indicates that the scheduler has reached the end of its life cycle gracefully
exit(String) - Static method in class org.voltdb.task.ScheduledAction: Create a ScheduledAction which indicates that the scheduler has reached the end of its life cycle gracefully
EXIT - Enum constant in enum class org.voltdb.task.ActionType: Scheduler has reached an end to its life cycle and is not scheduling any more procedures

F

fetchRow(int) - Method in class org.voltdb.VoltTable: Return a VoltTableRow instance with the specified index.
flattenToBuffer(ByteBuffer) - Method in class org.voltdb.types.GeographyPointValue: Serialize this point to a ByteBuffer.
flattenToBuffer(ByteBuffer) - Method in class org.voltdb.types.GeographyValue: Serialize this object to a ByteBuffer.
flattenToBuffer(ByteBuffer) - Method in class org.voltdb.VoltTable: Serialize this table to a given ByteBuffer.
FLOAT - Enum constant in enum class org.voltdb.VoltType: 8-bytes in IEEE 754 "double format".
fromId(byte) - Static method in enum class org.voltdb.task.TaskScope: Convert from an ID returned by TaskScope.getId() back to the TaskScope instance
fromJSONObject(JSONObject) - Static method in class org.voltdb.VoltTable: Construct a table from a JSON object.
fromJSONString(String) - Static method in class org.voltdb.VoltTable: Construct a table from a JSON string.
fromName(String) - Static method in enum class org.voltdb.task.TaskScope: Convert the name of a scope to a TaskScope instance in a case insensitive way.
fromWKT(String) - Static method in class org.voltdb.types.GeographyPointValue: Create a GeographyPointValue from a well-known text string.
fromWKT(String) - Static method in class org.voltdb.types.GeographyValue: Create a GeographyValue object from a well-known text string.

G

GEOGRAPHY - Enum constant in enum class org.voltdb.VoltType: Geography type, for geographical objects (polygons, etc)
GEOGRAPHY_POINT - Enum constant in enum class org.voltdb.VoltType: Point type, for a geographical point (long, lat)
GeographyPointValue - Class in org.voltdb.types: The Java class that corresponds to the SQL type GEOGRAPHY_POINT.
GeographyPointValue(double, double) - Constructor for class org.voltdb.types.GeographyPointValue: Construct a new GeographyPointValue from its coordinates.
GeographyValue - Class in org.voltdb.types: The Java class used to represent data with the SQL type GEOGRAPHY.
GeographyValue(String) - Constructor for class org.voltdb.types.GeographyValue: Create a GeographyValue object from an OGC well-known text-formatted string.
GeographyValue(List<List<GeographyPointValue>>) - Constructor for class org.voltdb.types.GeographyValue: Create a polygon from a list of rings.
get(byte) - Static method in enum class org.voltdb.VoltType: Statically create an enum value from the corresponding byte.
get(int) - Method in class org.voltdb.VoltTableRow: Retrieve the column of the current row at columnIndex.
get(int, VoltType) - Method in class org.voltdb.VoltTableRow: Retrieve a value from the row by specifying the column index and the type.
get(String, VoltType) - Method in class org.voltdb.VoltTableRow: Retrieve a value from the row by specifying the column name and the type.
getActiveRowIndex() - Method in class org.voltdb.VoltTableRow: Get the position in the table of this row instance, starting at zero for the first row.
getAttachment() - Method in interface org.voltdb.task.ActionResult: Retrieve the attachment associated with this scheduled procedure
getAttachment() - Method in class org.voltdb.task.ScheduledAction: Retrieve the optional attachment associated with this scheduled action
getBuffer() - Method in class org.voltdb.VoltTable: Directly access the table's underlying ByteBuffer.
getCallback() - Method in class org.voltdb.task.Action
getCallback() - Method in class org.voltdb.task.Interval
getCallback() - Method in class org.voltdb.task.ScheduledAction
getClient() - Method in class org.voltdb.InProcessVoltDBServer: Create and connect a client to the in-process VoltDB server.
getColumnCount() - Method in class org.voltdb.VoltTable
getColumnCount() - Method in class org.voltdb.VoltTableRow: Returns the number of columns in the table schema
getColumnIndex(String) - Method in class org.voltdb.VoltTable
getColumnIndex(String) - Method in class org.voltdb.VoltTableRow: Return the index of the column with the specified column name.
getColumnName(int) - Method in class org.voltdb.VoltTable: Return the name of the column with the specified index.
getColumnType(int) - Method in class org.voltdb.VoltTable
getColumnType(int) - Method in class org.voltdb.VoltTableRow: Return the type of the column with the specified index.
getCreateParams() - Method in enum class org.voltdb.VoltType: For JDBC, the name(s) of any type-specific parameter(s), e.g.
getDateAsDate(int) - Method in class org.voltdb.VoltTableRow: Retrieve the DateType equivalent to the value stored in the column specified by index.
getDateAsDate(String) - Method in class org.voltdb.VoltTableRow: Retrieve the DateType equivalent to the value stored in the column specified by columnName.
getDateAsLocalDate(int) - Method in class org.voltdb.VoltTableRow: Retrieve the java.time.LocalDate equivalent to the value stored in the column specified by index.
getDateAsLocalDate(String) - Method in class org.voltdb.VoltTableRow: Retrieve the java.time.LocalDate equivalent to the value stored in the column specified by columnName.
getDateAsSqlDate(int) - Method in class org.voltdb.VoltTableRow: Retrieve the java.sql.Date equivalent to the value stored in the column specified by index.
getDateAsSqlDate(String) - Method in class org.voltdb.VoltTableRow: Retrieve the java.sql.Date equivalent to the value stored in the column specified by columnName.
getDateAsUtilDate(int) - Method in class org.voltdb.VoltTableRow: Retrieve the java.util.Date equivalent to the value stored in the column specified by index.
getDateAsUtilDate(String) - Method in class org.voltdb.VoltTableRow: Retrieve the java.util.Date equivalent to the value stored in the column specified by columnName.
getDecimalAsBigDecimal(int) - Method in class org.voltdb.VoltTableRow: Retrieve the BigDecimal value stored in the column specified by the index.
getDecimalAsBigDecimal(String) - Method in class org.voltdb.VoltTableRow: Retrieve the BigDecimal value stored in the column specified by columnName.
getDependencies() - Method in interface org.voltdb.task.Initializable: If this method is implemented then the task will only be restarted when it or any classes marked as a dependency are modified.
getDouble(int) - Method in class org.voltdb.VoltTableRow: Retrieve the double value stored in the column specified by index.
getDouble(String) - Method in class org.voltdb.VoltTableRow: Retrieve the double value stored in the column specified by name.
getErrorMessage() - Method in class org.voltdb.utils.CompoundErrors: Creates an error message comprised of all of the error messages added to this instance by calling addErrorMessage(String).
getErrorMessage(String) - Method in class org.voltdb.utils.CompoundErrors: A specialized version of getErrorMessage(), using a specific separator.
getFirstAction() - Method in interface org.voltdb.task.ActionGenerator: This method is invoked only once to obtain the first action.
getFirstInterval() - Method in interface org.voltdb.task.IntervalGenerator: This method is invoked only once to obtain the first interval.
getFirstScheduledAction() - Method in interface org.voltdb.task.ActionScheduler: This method is invoked only once to obtain the first action and interval.
getFormatterBuilder() - Method in interface org.voltdb.importer.ImporterConfig: Returns a FormatterBuilder that can be used to construct the formatter for this import configuration.
getGeographyPointValue(int) - Method in class org.voltdb.VoltTableRow: Retrieve the GeographyPointValue value stored in the column specified by index.
getGeographyPointValue(String) - Method in class org.voltdb.VoltTableRow: Retrieve the GeographyPointValue value stored in the column specified by name.
getGeographyValue(int) - Method in class org.voltdb.VoltTableRow: Retrieve the GeographyValue value stored in the column specified by index.
getGeographyValue(String) - Method in class org.voltdb.VoltTableRow: Retrieve the GeographyValue value stored in the column specified by name.
getId() - Method in enum class org.voltdb.task.TaskScope
getInstanceForTest(ByteBuffer) - Static method in class org.voltdb.VoltTable: get a not fully constructed and validated VoltTable.
getInterval(TimeUnit) - Method in interface org.voltdb.task.ActionResult: Retrieve the interval after which the action was executed.
getInterval(TimeUnit) - Method in class org.voltdb.task.Interval
getInterval(TimeUnit) - Method in class org.voltdb.task.ScheduledAction
getJdbcClass() - Method in enum class org.voltdb.VoltType: Get the type that will be returned by JDBC's ResultSet.getObject(), which usually corresponds to to VoltTable.get(), except for timestamps.
getJdbcSqlType() - Method in enum class org.voltdb.VoltType: Get the java.sql.Types type of this type.
getLatitude() - Method in class org.voltdb.types.GeographyPointValue: Return the latitude of this point in degrees.
getLengthInBytes() - Static method in class org.voltdb.types.GeographyPointValue: Returns the number of bytes an instance of this class requires when serialized to a ByteBuffer.
getLengthInBytes() - Method in class org.voltdb.types.GeographyValue: Return the number of bytes in the serialization for this polygon.
getLengthInBytesForFixedTypes() - Method in enum class org.voltdb.VoltType: Get the number of bytes required to store the fixed length type.
getLengthInBytesForFixedTypesWithoutCheck() - Method in enum class org.voltdb.VoltType: Get the number of bytes required to store the fixed length type.
getLiteralPrefix() - Method in enum class org.voltdb.VoltType: For JDBC, returns the prefix (if any, otherwise null) used with SQL literal constants of this type.
getLiteralSuffix() - Method in enum class org.voltdb.VoltType: For JDBC, returns the suffix (if any, otherwise null) used with SQL literal constants of this type.
getLong(int) - Method in class org.voltdb.VoltTableRow: Retrieve the long value stored in the column specified by index.
getLong(String) - Method in class org.voltdb.VoltTableRow: Retrieve the long value stored in the column specified by name.
getLongitude() - Method in class org.voltdb.types.GeographyPointValue: Return the longitude of this point in degrees.
getMaximumScale() - Method in enum class org.voltdb.VoltType: Non-integer numeric VoltTypes must override this method.
getMaxLengthInBytes() - Method in enum class org.voltdb.VoltType: Get the maximum number of bytes required to store the type
getMaxValueForKeyPadding() - Method in enum class org.voltdb.VoltType: Returns the maximum possible value for a numeric type, as a string.
getMinimumScale() - Method in enum class org.voltdb.VoltType: Non-integer numeric VoltTypes must override this method.
getMinLengthInBytes() - Method in enum class org.voltdb.VoltType: Get the minimum number of bytes required to store the type
getMostCompatibleJavaTypeName() - Method in enum class org.voltdb.VoltType: Returns a string representing the most compatible Java class name corresponding to this VoltType.
getName() - Method in enum class org.voltdb.VoltType: Return the name of this type as a string.
getNullable() - Method in enum class org.voltdb.VoltType: VoltDB treats nullability as orthogonal to type, so all types are nullable.
getNullValue() - Method in enum class org.voltdb.VoltType: Get a value representing whichever null value is appropriate for the current VoltType enum.
getOffset(int) - Method in class org.voltdb.VoltTableRow: Computes the offset in the buffer to a column identified by its index.
getPriority() - Method in class org.voltdb.importer.AbstractImporter: Returns the execution priority for this importer.
getProcedure() - Method in class org.voltdb.task.Action
getProcedure() - Method in interface org.voltdb.task.ActionResult
getProcedure() - Method in class org.voltdb.task.ScheduledAction
getProcedureParameters() - Method in class org.voltdb.task.Action
getProcedureParameters() - Method in interface org.voltdb.task.ActionResult
getProcedureParameters() - Method in class org.voltdb.task.ScheduledAction
getRawRow() - Method in class org.voltdb.VoltTableRow
getResourceID() - Method in class org.voltdb.importer.AbstractImporter: Returns the resource id for which this importer was started.
getResourceID() - Method in interface org.voltdb.importer.ImporterConfig: Unique resource id for which the configuration is specified.
getResponse() - Method in interface org.voltdb.task.ActionResult
getRings() - Method in class org.voltdb.types.GeographyValue: Return the list of rings of a polygon.
getRow() - Method in class org.voltdb.VoltTableRow: Formats the table row as a comma-separated string.
getRowCount() - Method in class org.voltdb.VoltTable
getRowObjects() - Method in class org.voltdb.VoltTableRow: Retrieve the current row as an array of Objects.
getScopeId() - Method in interface org.voltdb.task.TaskHelper: Returns the ID of the scope when this helper is passed to an instantiate method otherwise -1
getSearchable() - Method in enum class org.voltdb.VoltType: Returns the standard JDBC 'searchable' attribute.
getSerializedSize() - Method in class org.voltdb.VoltTable: Get the serialized size in bytes of this table.
getSignatureChar() - Method in enum class org.voltdb.VoltType: Get a char that uniquely identifies a type.
getStatusCode() - Method in class org.voltdb.VoltTable: Set the status code associated with this table.
getStatusMessage() - Method in class org.voltdb.task.Action
getStatusMessage() - Method in class org.voltdb.task.ScheduledAction
getString(int) - Method in class org.voltdb.VoltTableRow: Retrieve the String value stored in the column specified by index.
getString(String) - Method in class org.voltdb.VoltTableRow: Retrieve the String value stored in the column specified by name.
getStringAsBytes(int) - Method in class org.voltdb.VoltTableRow: Retrieve the string value stored in the column specified by index as an array of bytes.
getStringAsBytes(String) - Method in class org.voltdb.VoltTableRow: Retrieve the string value stored in the column specified by name as an array of bytes.
getTableCheckSum(boolean) - Method in class org.voltdb.VoltTable: Calculate a rudimentary checksum of the table.
getTableSchema() - Method in class org.voltdb.VoltTable: Get the schema of the table.
getTaskName() - Method in interface org.voltdb.task.TaskHelper
getTaskScope() - Method in interface org.voltdb.task.TaskHelper
getTaskThreadName() - Method in class org.voltdb.importer.AbstractImporter: Returns the name of the thread on which this importer is currently executing.
getTime() - Method in class org.voltdb.types.TimestampType: Read the microsecond in time stored by this timestamp.
getTimestampAsLong(int) - Method in class org.voltdb.VoltTableRow: Retrieve the long timestamp stored in the column specified by index.
getTimestampAsLong(String) - Method in class org.voltdb.VoltTableRow: Retrieve the long timestamp value stored in the column specified by name.
getTimestampAsSqlTimestamp(int) - Method in class org.voltdb.VoltTableRow: Retrieve the java.sql.Timestamp equivalent to the value stored in the column specified by index.
getTimestampAsSqlTimestamp(String) - Method in class org.voltdb.VoltTableRow: Retrieve the java.sql.Timestamp equivalent to the value stored in the column specified by name.
getTimestampAsTimestamp(int) - Method in class org.voltdb.VoltTableRow: Retrieve the TimestampType value stored in the column specified by index.
getTimestampAsTimestamp(String) - Method in class org.voltdb.VoltTableRow: Retrieve the TimestampType value stored in the column specified by name.
getType() - Method in class org.voltdb.task.Action
getType() - Method in interface org.voltdb.task.ActionResult
getType() - Method in class org.voltdb.task.ScheduledAction
getTypeName() - Method in class org.voltdb.importer.AbstractImporterFactory: A unique name identifying the type of this importer.
getTypePrecisionAndRadix() - Method in enum class org.voltdb.VoltType: Returns precision and radix of this type.
getUSec() - Method in class org.voltdb.types.TimestampType: Get the microsecond portion of this timestamp
getValue() - Method in enum class org.voltdb.VoltType: Gets the byte that corresponds to the VoltType (for serialization).
getValueDisplaySize() - Static method in class org.voltdb.types.GeographyPointValue: The largest number of characters needed to represent a point value as a string.
getValueDisplaySize(int) - Static method in class org.voltdb.types.GeographyValue: Given a column of type GEOGRAPHY(nbytes), return an upper bound on the number of characters needed to represent any entity of this type in WKT.
getVarbinary(int) - Method in class org.voltdb.VoltTableRow: Retrieve the varbinary value stored in the column specified by index.
getVarbinary(String) - Method in class org.voltdb.VoltTableRow: Retrieve the varbinary value stored in the column specified by name.
getVarbinaryLen(int) - Method in class org.voltdb.VoltTableRow: Retrieve the length of the varbinary value stored in the column specified by index.

H

hasErrors() - Method in class org.voltdb.utils.CompoundErrors
hashCode() - Method in class org.voltdb.types.TimestampType: Hashcode with the same uniqueness as a Java Date.
hashCode() - Method in class org.voltdb.VoltTable.ColumnInfo
hashCode() - Method in class org.voltdb.VoltTable: Deprecated.
This only throws. Doesn't do anything.
hasSameContents(VoltTable) - Method in class org.voltdb.VoltTable: Check to see if this table has the same contents as the provided table.
hasSameContents(VoltTable, boolean) - Method in class org.voltdb.VoltTable: Check to see if this table has the same contents as the provided table, optionally ignoring the order of rows.
hasTransaction() - Method in class org.voltdb.importer.AbstractImporter: Returns whether the importer has a transaction ready to process.
HOSTS - Enum constant in enum class org.voltdb.task.TaskScope: Hosts scope
humanReadableSize(int) - Static method in enum class org.voltdb.VoltType: String representation of MAX_VALUE_LENGTH.

I

ImporterConfig - Interface in org.voltdb.importer: Represents importer configurations created from properties specified in deployment file.
info(Throwable, String, Object...) - Method in class org.voltdb.importer.AbstractImporter: Log a INFO level log message.
Initializable - Interface in org.voltdb.task: Base interface for all interfaces of classes which are supplied to the TaskManager for construction and initialization
INLIST_OF_BIGINT - Enum constant in enum class org.voltdb.VoltType: Special purpose internal type to describe expectations for parameters to statements that contain syntax like " integer_expr IN ? ".
INLIST_OF_STRING - Enum constant in enum class org.voltdb.VoltType: Special purpose internal type to describe expectations for parameters to statements that contain syntax like " varchar_expr IN ? ".
InProcessVoltDBServer - Class in org.voltdb: Class used to run a single VoltDB server in-process for debug and test purposes.
InProcessVoltDBServer() - Constructor for class org.voltdb.InProcessVoltDBServer: Create an instance ready to start.
INTEGER - Enum constant in enum class org.voltdb.VoltType: 4-byte signed 2s-complement integer.
Interval - Class in org.voltdb.task: Class to represent the time interval which should elapse before an action is performed.
Interval(long, TimeUnit, Function<ActionResult, Interval>) - Constructor for class org.voltdb.task.Interval: Constructor for an Interval.
IntervalGenerator - Interface in org.voltdb.task: Interface which calculates the time interval which should elapse until the next action should be performed
INVALID - Enum constant in enum class org.voltdb.VoltType: Used for uninitialized types in some places.
isAnyIntegerType() - Method in enum class org.voltdb.VoltType: Is this type an integer type? True for TINYINT, SMALLINT, INTEGER, BIGINT.
isAvroRecord(Class<?>) - Static method in enum class org.voltdb.VoltType: Tests whether a specified class is an Avro data record (a subclass of the generic Avro record class).
isBackendIntegerType() - Method in enum class org.voltdb.VoltType: Is this type an integer type in the EE? True for TINYINT, SMALLINT, INTEGER, BIGINT and TIMESTAMP.
isCaseSensitive() - Method in enum class org.voltdb.VoltType: Individual VoltTypes like String can override to enable this functionality.
isDebugEnabled() - Method in class org.voltdb.importer.AbstractImporter: Tests whether logging is enabled at the debug level.
isDebugLoggingEnabled() - Method in interface org.voltdb.task.TaskHelper
isExactNumeric() - Method in enum class org.voltdb.VoltType: Is the type a number and is it an exact value (no rounding errors)?
isImporterRunEveryWhere() - Method in class org.voltdb.importer.AbstractImporterFactory: Returns true if an importer instance must be run on every site for every resource.
isIndexable() - Method in enum class org.voltdb.VoltType: VoltTypes for indexable non-numeric values must override.
isJdbcVisible() - Method in enum class org.voltdb.VoltType: Is this type visible to JDBC
isNumber() - Method in enum class org.voltdb.VoltType: Tests whether this Volt type is numeric.
isProcedureReadOnly(String) - Method in interface org.voltdb.task.TaskHelper: Test if a procedure is read only.
isReadOnly() - Method in interface org.voltdb.task.ActionGenerator: Return false unless it is guaranteed that all procedures are also read only.
isStop() - Method in enum class org.voltdb.task.ActionType
isUniqueIndexable() - Method in enum class org.voltdb.VoltType: VoltTypes with special restrictions about uniqueness support must override.
isUnsigned() - Method in enum class org.voltdb.VoltType: Numeric types are all signed types, so return false.
isVariableLength() - Method in enum class org.voltdb.VoltType: Tests whether this type is a variable-length type.
isVoltNullValue(Object) - Static method in enum class org.voltdb.VoltType: Tests whether a supplied value is the null value for this Volt type.

L

loadRow(String, Object...) - Method in class org.voltdb.InProcessVoltDBServer: Helper method for loading a row into a table.
logDebug(String) - Method in interface org.voltdb.task.TaskHelper: Log a message in the system log at the debug log level
logDebug(String, Throwable) - Method in interface org.voltdb.task.TaskHelper: Log a message and throwable in the system log at the debug log level
logError(String) - Method in interface org.voltdb.task.TaskHelper: Log a message in the system log at the error log level
logError(String, Throwable) - Method in interface org.voltdb.task.TaskHelper: Log a message and throwable in the system log at the error log level
logInfo(String) - Method in interface org.voltdb.task.TaskHelper: Log a message in the system log at the info log level
logInfo(String, Throwable) - Method in interface org.voltdb.task.TaskHelper: Log a message and throwable in the system log at the info log level
logWarning(String) - Method in interface org.voltdb.task.TaskHelper: Log a message in the system log at the warning log level
logWarning(String, Throwable) - Method in interface org.voltdb.task.TaskHelper: Log a message and throwable in the system log at the warning log level

M

MAX_SERIALIZED_LENGTH - Static variable in class org.voltdb.types.GeographyValue: The maximum-allowed length (in bytes) for a column with type GEOGRAPHY.
MAX_SERIALIZED_TABLE_LENGTH - Static variable in class org.voltdb.VoltTable: Size in bytes of the maximum length for a VoltDB tuple.
MAX_SERIALIZED_TABLE_LENGTH_STR - Static variable in class org.voltdb.VoltTable: String representation of MAX_SERIALIZED_TABLE_LENGTH.
MAX_TUPLE_LENGTH - Static variable in class org.voltdb.VoltTableRow: Size in bytes of the maximum length for a VoltDB tuple.
MAX_TUPLE_LENGTH_STR - Static variable in class org.voltdb.VoltTableRow: String representation of MAX_TUPLE_LENGTH.
MAX_VALUE_LENGTH - Static variable in enum class org.voltdb.VoltType: Size in bytes of the maximum length for a VoltDB field value, presumably a STRING or VARBINARY
MAX_VALUE_LENGTH_IN_CHARACTERS - Static variable in enum class org.voltdb.VoltType: Size in characters of the maximum length for a VoltDB field value, using a worst-case estimate of 4 bytes per character
millisFromJDBCformat(String) - Static method in class org.voltdb.types.TimestampType: Given a string parseable by the JDBC Timestamp parser, return the fractional component in milliseconds.
MIN_SERIALIZED_LENGTH - Static variable in class org.voltdb.types.GeographyValue: The minimum-allowed length (in bytes) for a column with type GEOGRAPHY.

N

newStageList(Consumer<ClientResponse[]>) - Method in class org.voltdb.VoltCompoundProcedure: Returns a VoltCompoundProcedure.StageListBuilder for use in building the list of execution stages for this compound procedure.
normalizeLngLat(double, double) - Static method in class org.voltdb.types.GeographyPointValue: Create a GeographyPointValue with normalized coordinates.
NULL - Enum constant in enum class org.voltdb.VoltType: Used to type java null values that have no type.
NULL_BIGINT - Static variable in enum class org.voltdb.VoltType: Null value for BIGINT.
NULL_DATE - Static variable in enum class org.voltdb.VoltType: Null value for DATE.
NULL_DECIMAL - Static variable in enum class org.voltdb.VoltType: Null value for DECIMAL.
NULL_FLOAT - Static variable in enum class org.voltdb.VoltType: Null value for FLOAT.
NULL_GEOGRAPHY - Static variable in enum class org.voltdb.VoltType: Null value for GEOGRAPHY.
NULL_INTEGER - Static variable in enum class org.voltdb.VoltType: Null value for INTEGER.
NULL_POINT - Static variable in enum class org.voltdb.VoltType: Null value for GEOGRAPHY_POINT.
NULL_SMALLINT - Static variable in enum class org.voltdb.VoltType: Null value for SMALLINT.
NULL_STRING_LENGTH - Static variable in enum class org.voltdb.VoltType: Length value for a null string.
NULL_STRING_OR_VARBINARY - Static variable in enum class org.voltdb.VoltType: Null value for STRING or VARBINARY.
NULL_TIMESTAMP - Static variable in enum class org.voltdb.VoltType: Null value for TIMESTAMP.
NULL_TINYINT - Static variable in enum class org.voltdb.VoltType: Null value for TINYINT.
NUMERIC - Enum constant in enum class org.voltdb.VoltType: Used for some literal constants parsed by our SQL parser.

O

of(Action) - Static method in class org.voltdb.task.ScheduledAction: Create a ScheduledAction from a Action which is of type stop.
of(Interval, Action) - Static method in class org.voltdb.task.ScheduledAction: Create a ScheduledAction from a Interval and Action.
org.voltdb - package org.voltdb
org.voltdb.importer - package org.voltdb.importer
org.voltdb.task - package org.voltdb.task: Provides classes and interfaces for supporting task creation for execution of procedures and custom java on a schedule
org.voltdb.types - package org.voltdb.types
org.voltdb.utils - package org.voltdb.utils

P

PARTITIONS - Enum constant in enum class org.voltdb.task.TaskScope: Partitions scope
PROCEDURE - Enum constant in enum class org.voltdb.task.ActionType: Schedule a procedure to be executed
procedureCall(long, TimeUnit, Function<ActionResult, ScheduledAction>, String, Object...) - Static method in class org.voltdb.task.ScheduledAction: Create a ScheduledAction which executes a procedure with given parameters after interval
procedureCall(Function<ActionResult, Action>, String, Object...) - Static method in class org.voltdb.task.Action: Create an Action which executes a procedure with given parameters

Q

queueProcedureCall(String, Object...) - Method in class org.voltdb.VoltCompoundProcedure: Queues an asynchronous procedure call, to be executed when the current stage returns.

R

rateLimitedLog(Level, Throwable, String, Object...) - Method in class org.voltdb.importer.AbstractImporter: This rate limited log must be used by the importers to log messages that may happen frequently and must be rate limited.
reportInitializedStat(String) - Method in class org.voltdb.importer.AbstractImporter: Called when the importer is initialized, to update statistics records used by VMC.
resetRowPosition() - Method in class org.voltdb.VoltTableRow: Sets the active position indicator so that the next call to VoltTableRow.advanceRow() will make the first record active.
restrictProcedureByScope() - Method in interface org.voltdb.task.ActionGenerator: If this method returns true that means the type of procedure which this scheduler can run is restricted based upon the scope type.
runDDLFromPath(String) - Method in class org.voltdb.InProcessVoltDBServer: Run DDL from a file on disk.
runDDLFromString(String) - Method in class org.voltdb.InProcessVoltDBServer: Run DDL from a given string.

S

ScheduledAction - Class in org.voltdb.task: Class which describes an interval, an action to perform after that interval and a callback which should be invoked after the action has been performed.
serialize(DataOutput) - Method in class org.voltdb.types.GeographyPointValue: Serialize this point to a DataOutput
serialize(DataOutput) - Method in class org.voltdb.types.GeographyValue: Serialize this object to a DataOutput
serializeNull(ByteBuffer) - Static method in class org.voltdb.types.GeographyPointValue: Serialize the null point (that is, a SQL null value) to a ByteBuffer, at the buffer's current position.
setAppStatusCode(byte) - Method in class org.voltdb.VoltCompoundProcedure: Set the application status code that will be returned to the client as part of the ClientResponse.
setAppStatusString(String) - Method in class org.voltdb.VoltCompoundProcedure: Set the application status string that will be returned to the client as part of the ClientResponse.
setAttachment(Object) - Method in class org.voltdb.task.ScheduledAction: Add an arbitrary attachment to this instance so that it can be retrieved from the ActionResult
setImportServerAdapter(ImporterServerAdapter) - Method in class org.voltdb.importer.AbstractImporter: Passes in the server adapter that may be used by this importer to access the server, like calling a procedure.
setImportServerAdapter(ImporterServerAdapter) - Method in class org.voltdb.importer.AbstractImporterFactory: Passes in the adapter class that the importers may use to execute procedures.
setPriority(int) - Method in class org.voltdb.importer.AbstractImporter: Sets the execution priority for this importer.
setStatusCode(byte) - Method in class org.voltdb.VoltTable: Set the status code associated with this table.
setStatusMessage(String) - Method in class org.voltdb.task.Action: Set the optional status massage which will be reported in the statistics for a task and if this is an ActionType.ERROR or ActionType.EXIT action then it will also be logged.
setStatusMessage(String) - Method in class org.voltdb.task.ScheduledAction: Set the optional status message which will be reported in the statistics for a task and if this is an ActionType.ERROR or ActionType.EXIT action then it will also be logged.
shouldRun() - Method in class org.voltdb.importer.AbstractImporter: This method indicates if the importer has been stopped or if it should continue running.
shutdown() - Method in class org.voltdb.InProcessVoltDBServer: Stop the in-process server and block until it has completely stopped.
SMALLINT - Enum constant in enum class org.voltdb.VoltType: 2-byte signed 2s-complement short.
start() - Method in class org.voltdb.InProcessVoltDBServer: Starts the in-process server and blocks until it is ready to accept connections.
start(BundleContext) - Method in class org.voltdb.importer.AbstractImporterFactory: Registers this as an OSGi service.
stop() - Method in class org.voltdb.importer.AbstractImporter: This is called by the importer framework to stop the importer.
stop(BundleContext) - Method in class org.voltdb.importer.AbstractImporterFactory
stopImporter() - Method in class org.voltdb.importer.AbstractImporter: Called to stop the importer from processing more data.
STRING - Enum constant in enum class org.voltdb.VoltType: UTF-8 string with up to 32K chars.

T

TaskHelper - Interface in org.voltdb.task: Helper interface passed to IntervalGenerator, ActionGenerator and ActionScheduler instances for calling in to the volt system to perform logging, validation and other operations
TaskScope - Enum Class in org.voltdb.task: Enum to represent the different scopes in which a Task can run
then(Consumer<ClientResponse[]>) - Method in class org.voltdb.VoltCompoundProcedure.StageListBuilder: Adds the next sequential state to the list of stages
TIMESTAMP - Enum constant in enum class org.voltdb.VoltType: 8-byte long value representing microseconds after the epoch.
TimestampType - Class in org.voltdb.types: Represent a microsecond-accurate VoltDB timestamp type.
TimestampType() - Constructor for class org.voltdb.types.TimestampType: Create a TimestampType instance for the current time.
TimestampType(long) - Constructor for class org.voltdb.types.TimestampType: Create a TimestampType from microseconds from epoch.
TimestampType(String) - Constructor for class org.voltdb.types.TimestampType: Construct from a timestamp string in a complete date or time format.
TimestampType(Date) - Constructor for class org.voltdb.types.TimestampType: Create a TimestampType from a Java Date class.
TINYINT - Enum constant in enum class org.voltdb.VoltType: 1-byte signed 2s-complement byte.
toFormattedString() - Method in class org.voltdb.VoltTable: Return a "pretty print" representation of this table with column names.
toFormattedString(boolean) - Method in class org.voltdb.VoltTable: Return a "pretty print" representation of this table with or without column names.
toJSONString() - Method in class org.voltdb.types.TimestampType
toJSONString() - Method in class org.voltdb.VoltTable: Get a JSON representation of this table.
toJSONStringerV2(JSONStringer) - Method in class org.voltdb.VoltTable: Get a JSON /api/2.0/ representation of this table.
toSQLString() - Method in enum class org.voltdb.VoltType: Get the corresponding SQL type as for a given VoltType enum.
toString() - Method in class org.voltdb.task.Action
toString() - Method in class org.voltdb.task.Interval
toString() - Method in class org.voltdb.task.ScheduledAction
toString() - Method in class org.voltdb.types.GeographyPointValue: Return this point as a well-known text string.
toString() - Method in class org.voltdb.types.GeographyValue: Return a representation of this object as well-known text.
toString() - Method in class org.voltdb.types.TimestampType: An implementation of toString for debugging and printing VoltTables.
toString() - Method in class org.voltdb.VoltTable.ColumnInfo
toString() - Method in class org.voltdb.VoltTable: Returns a String representation of this table.
toString() - Method in enum class org.voltdb.VoltType: Return the string representation of this type.
toString(TimeZone) - Method in class org.voltdb.types.TimestampType: An implementation of toString for debugging and printing VoltTables which allows the specification of a timezone.
toWKT() - Method in class org.voltdb.types.GeographyPointValue: Return this point as a well-known text string.
toWKT() - Method in class org.voltdb.types.GeographyValue: Return a representation of this object as well-known text.
translateIdToName(byte) - Static method in enum class org.voltdb.task.TaskScope: Convert a scope ID to the name of that scope
typeFromClass(Class<?>) - Static method in enum class org.voltdb.VoltType: Ascertain the most appropriate VoltType given a java class.
typeFromObject(Object) - Static method in enum class org.voltdb.VoltType: Ascertain the most appropriate VoltType given a java object.
typeFromString(String) - Static method in enum class org.voltdb.VoltType: Converts string representations to an enum value.

U

unflattenFromBuffer(ByteBuffer) - Static method in class org.voltdb.types.GeographyPointValue: Deserialize a point from a ByteBuffer at the buffer's current position
unflattenFromBuffer(ByteBuffer) - Static method in class org.voltdb.types.GeographyValue: Deserialize a GeographyValue from a ByteBuffer at the ByteBuffer's current position.
unflattenFromBuffer(ByteBuffer, int) - Static method in class org.voltdb.types.GeographyPointValue: Deserializes a point from a ByteBuffer, at an absolute offset.
unflattenFromBuffer(ByteBuffer, int) - Static method in class org.voltdb.types.GeographyValue: Deserialize a GeographyValue from a ByteBuffer from an absolute offset.

V

validateProcedure(CompoundErrors, boolean, String, Object[]) - Method in interface org.voltdb.task.TaskHelper: Validate that a procedure with name exists and parameters are valid for that procedure.
valueOf(String) - Static method in enum class org.voltdb.task.ActionType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.voltdb.task.TaskScope: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class org.voltdb.VoltType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.voltdb.task.ActionType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.voltdb.task.TaskScope: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class org.voltdb.VoltType: Returns an array containing the constants of this enum class, in the order they are declared.
valueToBytes(Object) - Static method in enum class org.voltdb.VoltType: Converts the object into bytes for hashing.
VARBINARY - Enum constant in enum class org.voltdb.VoltType: Array of bytes of variable length
varbinaryToPrintableString(byte[]) - Static method in class org.voltdb.VoltTable: Make a printable, short string for a varbinary.
vectorClassFromType() - Method in enum class org.voltdb.VoltType: Return the java class that is matched to a given VoltType.
VoltCompoundProcedure - Class in org.voltdb: Base class for any user-provided compound procedures.
VoltCompoundProcedure() - Constructor for class org.voltdb.VoltCompoundProcedure
VoltCompoundProcedure.CompoundProcAbortException - Exception in org.voltdb: Thrown from a stored procedure to abort a VoltCompoundProcedure.
VoltCompoundProcedure.Stage - Class in org.voltdb: Represents the stages of processing of a VoltCompoundProcedure.
VoltCompoundProcedure.StageListBuilder - Class in org.voltdb: Builds a list of execution stages for this VoltCompoundProcedure.
VoltTable - Class in org.voltdb: The primary representation of a result set (of tuples) or a temporary table in VoltDB.
VoltTable(VoltTable.ColumnInfo[]) - Constructor for class org.voltdb.VoltTable: Create an empty table from column schema given as an array.
VoltTable(VoltTable.ColumnInfo[], int) - Constructor for class org.voltdb.VoltTable: Create an empty table from column schema.
VoltTable(VoltTable.ColumnInfo, VoltTable.ColumnInfo...) - Constructor for class org.voltdb.VoltTable: Create an empty table from column schema.
VOLTTABLE - Enum constant in enum class org.voltdb.VoltType: VoltTable type for Procedure parameters
VoltTable.ColumnInfo - Class in org.voltdb: Object that represents the name and schema for a VoltTable column.
VoltTableRow - Class in org.voltdb: Represents the interface to a row in a VoltTable result set.
VoltType - Enum Class in org.voltdb: Represents a type for a VoltTable column or a SQLStmt parameter.
VoltType.LengthRange - Class in org.voltdb: Support class to represent optional value length variability.

W

warn(Throwable, String, Object...) - Method in class org.voltdb.importer.AbstractImporter: Log a WARN level log message.
wasNull() - Method in class org.voltdb.VoltTableRow: Returns whether last retrieved value was null.

A B C D E F G H I L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form