Index (eznosql v1.1.5 API)

A B C D E F G I K L M N P R S T U V
All Classes All Packages

A

abort() - Method in class com.ibm.eznosql.Connection: Initiates a rollback of uncommitted transactions in a recoverable database.
ADD_INDEX_ACTIVE_INDEX - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException
ADD_INDEX_UNIQUE_DUPE_KEY - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException
addIndex(String) - Method in class com.ibm.eznosql.Database: Activates a previously defined secondary index.
ALL - com.ibm.eznosql.options.LogOptions: Indicates that the database is recoverable and supports both back out and forward recovery logging.

B

build() - Method in class com.ibm.eznosql.options.DatabaseOptions.Builder: Validates and builds a DatabaseOptions instance from the current state of the Builder.
Builder(String) - Constructor for class com.ibm.eznosql.options.DatabaseOptions.Builder: The Builder() constructor will initialize with default values.

C

clearResultSet() - Method in class com.ibm.eznosql.ResultSet
close() - Method in class com.ibm.eznosql.Connection: Disconnects an established connection to an EzNoSQL database and invalidates its connection token.
close() - Method in class com.ibm.eznosql.ReadUpdateResultSet
close() - Method in class com.ibm.eznosql.ResultSet: Ends positioning into the EzNoSQL database previously obtained by the Connection.read(java.lang.String, java.lang.String) or Connection.readGeneric(java.lang.String, java.lang.String) ResultSet methods.
CLOSE_WITHOUT_POSITIONING - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException
com.ibm.eznosql - package com.ibm.eznosql
com.ibm.eznosql.exception - package com.ibm.eznosql.exception
com.ibm.eznosql.options - package com.ibm.eznosql.options
com.ibm.eznosql.result - package com.ibm.eznosql.result
commit() - Method in class com.ibm.eznosql.Connection: Commits one or more transactions in a recoverable database.
CONN_DATABASE_NOT_FOUND - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException
Connection - Class in com.ibm.eznosql: The Connection class represents a connection between the user's task and the database.
ConnectionIntegrity - Enum in com.ibm.eznosql.options: The ConnectionIntegrity enum represents read integrity access when establishing a new Connection instance via Connection.fromDataSetName(String, EnumSet, ConnectionIntegrity, short, boolean).
CONSISTENT_READ - com.ibm.eznosql.options.ConnectionIntegrity: Consistent Read (CR) indicates shared locks are obtained to protect a reader from viewing the document in the middle of an update.
CONSISTENT_READ_EXTENDED - com.ibm.eznosql.options.ConnectionIntegrity: Consistent Read Extended (CRE) indicates shared locks are obtained to protect a reader from viewing the document in the middle of an update.
createIndex(String, String, String) - Method in class com.ibm.eznosql.Database: Defines a secondary index with the provided alternate key, .PATH and .AIX index data sets.
createIndex(String, String, String, int, EnumSet<IndexFlags>) - Method in class com.ibm.eznosql.Database: Defines a secondary index with the provided alternate key and secondary index data set.
createResult() - Static method in class com.ibm.eznosql.result.DeleteResult
createResult() - Static method in class com.ibm.eznosql.result.InsertResult
createResult() - Static method in class com.ibm.eznosql.result.ReadResult
createResult() - Static method in class com.ibm.eznosql.result.ReplaceResult

D

Database - Class in com.ibm.eznosql: The Database class represents an EzNoSQL database identified by its data set name.
Database(String) - Constructor for class com.ibm.eznosql.Database: Instantiates a Database object with an existing EzNoSQL data set.
DATABASE_NOT_IN_CATALOG - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException
DatabaseOptions - Class in com.ibm.eznosql.options: The DatabaseOptions class represents optional configuration parameters when defining a new EzNoSQL Database.
DatabaseOptions.Builder - Class in com.ibm.eznosql.options: Fields can be assigned with corresponding 'set' methods.
delete() - Method in class com.ibm.eznosql.ResultSet: Deletes the previously positioned document obtained with a prior a ResultSet.next(boolean) with forUpdate = true from the database.
delete(String) - Static method in class com.ibm.eznosql.Database: Permanently deletes an EzNoSQL database.
deleteOne(String, String) - Method in class com.ibm.eznosql.Connection: Deletes a single document from a database.
DeleteResult - Class in com.ibm.eznosql.result: The DeleteResult class represents the returned output of a Connection.deleteOne(String, String) request.
DESCENDING_KEYS - com.ibm.eznosql.options.IndexFlags: Indicates descending sequential access when retrieving documents through a secondary index.
DESCENDING_KEYS - com.ibm.eznosql.options.ReadAccess: Indicates descending sequential access when retrieving documents through the primary index.
DESTROY_DB_NOT_FOUND - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException
detailedMessage - Variable in exception com.ibm.eznosql.exception.EzNoSQLException: The native EzNoSQL detailed error message.
dropIndex(String) - Method in class com.ibm.eznosql.Database: Disables an active secondary index.
DUPE_AND_TRUNCATED_DETECTED - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException
DUPE_AND_TRUNCATED_DETECTED_MSG - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException
DUPLICATE_DB_NAME_DETECTED - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException
DUPLICATE_KEY_VALUE_DETECTED - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException
DUPLICATE_KEY_VALUE_MSG - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException

E

EzNoSQLException - Exception in com.ibm.eznosql.exception: An exception class representing errors which may have occurred while performing a EzNoSQL operation.
EzNoSQLException(int, String) - Constructor for exception com.ibm.eznosql.exception.EzNoSQLException: Creates an exception with the specified error message and native return code.
EzNoSQLException(int, String, String) - Constructor for exception com.ibm.eznosql.exception.EzNoSQLException: Creates an exception with the specified error message, native return code, and detailed error message.
EzNoSQLException(String) - Constructor for exception com.ibm.eznosql.exception.EzNoSQLException: Creates an exception with the specified error message.
EzNoSQLException(String, Throwable) - Constructor for exception com.ibm.eznosql.exception.EzNoSQLException: Creates an exception with the specified error message and cause.

F

FORCE_UPDATE - com.ibm.eznosql.options.ReadAccess: Indicates write force is used when attempting to insert a document with a duplicate key name either for the primary index or a unique secondary index.
fromDataSetName(String) - Static method in class com.ibm.eznosql.Connection: Instantiates a connection to an EzNoSQL database with a unique connection token.
fromDataSetName(String, EnumSet<ReadAccess>, ConnectionIntegrity, short, boolean) - Static method in class com.ibm.eznosql.Connection: Instantiates a connection to an EzNoSQL database with a unique connection token.
fromDbParameters(String, DatabaseOptions) - Static method in class com.ibm.eznosql.Database: Instantiates a new EzNoSQL Database using an autogenerated key.
fromDbParameters(String, String, DatabaseOptions) - Static method in class com.ibm.eznosql.Database: Instantiates a new EzNoSQL Database using a provided primary key.
fromReadUpdateParameters(Connection, String, String) - Static method in class com.ibm.eznosql.ReadUpdateResultSet: Instantiates a ReadUpdateResultSet for an EzNoSQL document with the specified key and value.

G

getAutoKeyValue() - Method in class com.ibm.eznosql.result.InsertResult
getAvgDocSize() - Method in class com.ibm.eznosql.options.DatabaseOptions: Getter for average document size value.
getDataClass() - Method in class com.ibm.eznosql.options.DatabaseOptions: Getter for Data Class value.
getDetailedMessage() - Method in exception com.ibm.eznosql.exception.EzNoSQLException: Returns the detailed message from the error, if available.
getDocument() - Method in class com.ibm.eznosql.result.ReadResult
getFlags() - Method in enum com.ibm.eznosql.options.ConnectionIntegrity
getIntFlag(EnumSet<IndexFlags>) - Static method in enum com.ibm.eznosql.options.IndexFlags: Getter method for retrieving the numerical value of an IndexFlags enum.
getIntFlag(EnumSet<ReadAccess>) - Static method in enum com.ibm.eznosql.options.ReadAccess: Getter method for retrieving the numerical value of a ReadAccess EnumSet.
getLogOption() - Method in class com.ibm.eznosql.options.DatabaseOptions: Getter for LogOption value.
getLogOptionValue() - Method in enum com.ibm.eznosql.options.LogOptions
getLogStreamId() - Method in class com.ibm.eznosql.options.DatabaseOptions: Getter for Log Stream ID value.
getMaxSpace() - Method in class com.ibm.eznosql.options.DatabaseOptions: Getter for maxSpace value.
getMessage() - Method in class com.ibm.eznosql.result.Result
getMgmtClass() - Method in class com.ibm.eznosql.options.DatabaseOptions: Getter for Management Class value.
getOrderedIndexEnabled() - Method in class com.ibm.eznosql.options.DatabaseOptions: Getter for orderedIndexEnabled value.
getResult() - Method in class com.ibm.eznosql.result.Result
getReturnCode() - Method in exception com.ibm.eznosql.exception.EzNoSQLException: Returns the native return code from the EzNoSQL invocation.
getReturnCode() - Method in class com.ibm.eznosql.result.Result
getStatistics() - Method in class com.ibm.eznosql.Connection: Generates connection statistics and configuration details for a connected EzNoSQL database.
getStorageClass() - Method in class com.ibm.eznosql.options.DatabaseOptions: Getter for Storage Class value.
getUpdatePercent() - Method in class com.ibm.eznosql.options.DatabaseOptions: Getter for update percentage value.

I

ILLEGAL_KEY_CHANGE - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException
ILLEGAL_KEY_CHANGE_MSG - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException
INACTIVE_SECONDARY_INDEX - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException
IndexFlags - Enum in com.ibm.eznosql.options: The IndexFlags enum represents unique and non-unique flags when defining a new secondary index using Database.createIndex(String, String, String, int, EnumSet).
InputValidator - Class in com.ibm.eznosql.exception: InputValidator is a helper class that performs basic String parameter validation for known format violations.
InputValidator() - Constructor for class com.ibm.eznosql.exception.InputValidator
insert(String) - Method in class com.ibm.eznosql.Connection: Inserts a single JSON document into an autogenerated key database.
insert(String, String) - Method in class com.ibm.eznosql.Connection: Inserts a single JSON document into a primary key database.
insertNext(String) - Method in class com.ibm.eznosql.ResultSet: Inserts document sequentially into a positioned ResultSet.
insertNext(String, String) - Method in class com.ibm.eznosql.ResultSet: Inserts document sequentially into a positioned ResultSet.
InsertResult - Class in com.ibm.eznosql.result: The InsertResult class represents the returned output of a Connection.insert(String) or Connection.insert(String, String) request.

K

KEY_LEN_255_MSG - Static variable in class com.ibm.eznosql.exception.InputValidator
KEY_VALUE_NOT_FOUND - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException
KEY_VALUE_NOT_FOUND_MSG - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException

L

LogOptions - Enum in com.ibm.eznosql.options: The DatabaseLogOptions enum represents database recovery options when defining a new Database.

M

main(String[]) - Static method in enum com.ibm.eznosql.options.IndexFlags

N

nativeRC - Variable in exception com.ibm.eznosql.exception.EzNoSQLException: The native EzNoSQL return code.
next() - Method in class com.ibm.eznosql.ReadUpdateResultSet: Retrieves the current document in the ReadUpdateResultSet.
next(boolean) - Method in class com.ibm.eznosql.ResultSet: Retrieves the current document in a queried ResultSet and positions to the next document.
NO_READ_INTEGRITY - com.ibm.eznosql.options.ConnectionIntegrity: No Read Integrity (NRI) indicates that the latest version of the document is returned at the time of the read.
NON_UNIQUE_INDEX_DUPLICATE_KEY_VALUE - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException
NON_UNIQUE_KEYS - com.ibm.eznosql.options.IndexFlags: Indicates the creation of a non-unique secondary index.
NONE - com.ibm.eznosql.options.LogOptions: Indicates that the database is non-recoverable.
NULL_EMPTY_STRING_MSG - Static variable in class com.ibm.eznosql.exception.InputValidator
NUX_DUPLICATE_KEY_MSG - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException

P

pattern - Static variable in class com.ibm.eznosql.exception.InputValidator

R

read(String, String) - Method in class com.ibm.eznosql.Connection: Instantiates a ResultSet positioned to the first exact match in the database.
READ_ONLY - com.ibm.eznosql.options.ReadAccess: Indicates read only access is requested for the connection.
ReadAccess - Enum in com.ibm.eznosql.options: The ReadAccess enum represents access levels when defining a new Connection instance in Connection.fromDataSetName(String, EnumSet, ConnectionIntegrity, short, boolean).
readGeneric(String, String) - Method in class com.ibm.eznosql.Connection: Instantiates a ResultSet positioned to the first generic match in the database.
readOne(String, String) - Method in class com.ibm.eznosql.Connection: Reads a single JSON document from the database.
readOneForUpdate(String, String) - Method in class com.ibm.eznosql.Connection: Obtains an exclusive Read/Update lock and returns a ReadUpdateResultSet for a single document in a database.
ReadResult - Class in com.ibm.eznosql.result: The ReadResult class represents the returned output of a Connection.readOne(String, String) request.
ReadUpdateResultSet - Class in com.ibm.eznosql: This class represents a direct read and exclusive document lock into the database, obtained as a result of a Connection.readOneForUpdate(String, String).
replace(String) - Method in class com.ibm.eznosql.ResultSet: Replaces a document that was previously retrieved by ResultSet.next(boolean) with forUpdate = true or Connection.readOneForUpdate(String, String) with a new document.
replaceOne(String, String, String) - Method in class com.ibm.eznosql.Connection: Queries the database for a document by key:value and issues a replace request.
ReplaceResult - Class in com.ibm.eznosql.result: The ReplaceResult class represents the returned output of a Connection.replaceOne(String, String, String) request.
Result - Class in com.ibm.eznosql.result: Base abstract class for <API_NAME>Result return types.
ResultSet - Class in com.ibm.eznosql: This class represents a positioning into the database.
ResultSet() - Constructor for class com.ibm.eznosql.ResultSet
resultToken - Variable in class com.ibm.eznosql.ResultSet

S

setAutoCommit(boolean) - Method in class com.ibm.eznosql.Connection: Indicates whether transactions should be automatically committed in a recoverable database.
setAvgDocSize(int) - Method in class com.ibm.eznosql.options.DatabaseOptions.Builder: Optional setter method for average document size.
setDataClas(String) - Method in class com.ibm.eznosql.options.DatabaseOptions.Builder: Optional setter method for an SMS-managed Data Class.
setLogOptions(LogOptions) - Method in class com.ibm.eznosql.options.DatabaseOptions.Builder: Optional setter method for LogOptions.
setLogStreamId(String) - Method in class com.ibm.eznosql.options.DatabaseOptions.Builder: Optional setter method for a Log stream ID; Note that a valid logStream ID must be set if a recoverable database is defined with LogOptions.ALL.
setMaxSpace(int) - Method in class com.ibm.eznosql.options.DatabaseOptions.Builder: Optional setter method for maxSpace.
setMgmtClas(String) - Method in class com.ibm.eznosql.options.DatabaseOptions.Builder: Optional setter method for an SMS Management Class.
setOrderedIndexEnabled(boolean) - Method in class com.ibm.eznosql.options.DatabaseOptions.Builder: Optional setter method for ordered index.
setUpdatePercent(int) - Method in class com.ibm.eznosql.options.DatabaseOptions.Builder: Optional setter method for update percentage.
STORAGE_DATA_CLASS_NOT_FOUND - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException

T

TRUNCATED_KEY_VALUE_DETECTED - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException
TRUNCATED_KEY_VALUE_DETECTED_MSG - Static variable in exception com.ibm.eznosql.exception.EzNoSQLException

U

UNDO - com.ibm.eznosql.options.LogOptions: Indicates the database is recoverable and supports back out logging only.

V

validateDataSetName(String) - Static method in class com.ibm.eznosql.exception.InputValidator: Performs String parameter validation on a data set name.
validateKeyName(String) - Static method in class com.ibm.eznosql.exception.InputValidator: Performs String parameter validation on a key name.
validateString(String) - Static method in class com.ibm.eznosql.exception.InputValidator: Performs String parameter validation.
valueOf(String) - Static method in enum com.ibm.eznosql.options.ConnectionIntegrity: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.eznosql.options.IndexFlags: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.eznosql.options.LogOptions: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.eznosql.options.ReadAccess: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.ibm.eznosql.options.ConnectionIntegrity: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.eznosql.options.IndexFlags: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.eznosql.options.LogOptions: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.eznosql.options.ReadAccess: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G I K L M N P R S T U V
All Classes All Packages