public interface Row extends RecordValue
TableAPI
.
Row objects are constructed explicitly using
createRow
or implicitly when returned from table
access operations.
Modifier and Type | Method and Description |
---|---|
Row |
clone()
Returns a deep copy of this object.
|
PrimaryKey |
createPrimaryKey()
Creates a PrimaryKey from this Row.
|
boolean |
equals(Object other)
Equality comparison for Row instances is based on equality of the
individual field values and ignores the included
Version , if
present. |
long |
getExpirationTime()
Returns the expiration time of the row.
|
Table |
getTable()
Return the Table associated with this row.
|
int |
getTableVersion()
Returns the version of the table used to create this row if it has been
deserialized from a get operation.
|
TimeToLive |
getTTL()
Returns the time to live (TTL) value for this row or null if it
has not been set by a call to
setTTL(oracle.kv.table.TimeToLive) . |
Version |
getVersion()
Returns the Version for the row.
|
void |
setTTL(TimeToLive ttl)
Sets a time to live (TTL) value for the row to be used when the row
is inserted into a store.
|
clear, contains, contains, copyFrom, get, get, getDefinition, getFieldName, getFieldNames, getFieldPos, getFields, isEmpty, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, put, putArray, putArray, putArray, putArray, putArray, putArray, putArrayAsJson, putArrayAsJson, putArrayAsJson, putArrayAsJson, putEnum, putEnum, putFixed, putFixed, putJson, putJson, putJson, putJson, putJsonNull, putJsonNull, putMap, putMap, putMap, putMap, putMapAsJson, putMapAsJson, putMapAsJson, putMapAsJson, putNull, putNull, putNumber, putNumber, putNumber, putNumber, putNumber, putNumber, putNumber, putNumber, putNumber, putNumber, putRecord, putRecord, putRecord, putRecord, putRecordAsJson, putRecordAsJson, putRecordAsJson, putRecordAsJson, remove, size, toString
asArray, asBinary, asBoolean, asDouble, asEnum, asFixedBinary, asFloat, asIndexKey, asInteger, asLong, asMap, asNumber, asPrimaryKey, asRecord, asRow, asString, asTimestamp, getType, isArray, isAtomic, isBinary, isBoolean, isComplex, isDouble, isEMPTY, isEnum, isFixedBinary, isFloat, isIndexKey, isInteger, isJsonNull, isLong, isMap, isNull, isNumber, isNumeric, isPrimaryKey, isRecord, isRow, isString, isTimestamp, toJsonString
compareTo
Table getTable()
Version getVersion()
Version
in its class description refers to its use in the KVStore
interface. In TableAPI
it it used as a return value for the
various put methods as well as TableAPI.putIfVersion(oracle.kv.table.Row, oracle.kv.Version, oracle.kv.table.ReturnRow, oracle.kv.table.WriteOptions)
and
TableAPI.deleteIfVersion(oracle.kv.table.PrimaryKey, oracle.kv.Version, oracle.kv.table.ReturnRow, oracle.kv.table.WriteOptions)
to perform conditional updates to
allow an application to ensure that an update is occurring on the
desired version of a row.PrimaryKey createPrimaryKey()
int getTableVersion()
boolean equals(Object other)
Version
, if
present.Row clone()
clone
in interface FieldValue
clone
in interface RecordValue
void setTTL(TimeToLive ttl)
TimeToLive.DO_NOT_EXPIRE
, exists as a convenience for that purpose.
It is recommended that the TimeToLive be constructed using
TimeToLive.ofDays(long)
to use less space in the store. If hours are
needed then TimeToLive.ofHours(long)
can be used at the expense of
additional storage used.
ttl
- the value to use, may be nullIllegalArgumentException
- if the TimeToLive is negativeTimeToLive getTTL()
setTTL(oracle.kv.table.TimeToLive)
. If this is null
it means that the table default will be used on a put operation.
The TTL property of a Row is used only on input. The expiration time
of a Row is available on output, or after a put operation using
getExpirationTime()
.long getExpirationTime()
TableAPI.get(oracle.kv.table.PrimaryKey, oracle.kv.table.ReadOptions)
) or table iterator
(e.g. TableAPI.tableIterator(oracle.kv.table.PrimaryKey, oracle.kv.table.MultiRowOptions, oracle.kv.table.TableIteratorOptions)
) call. It will also be valid after
a successful put of the row (e.g. TableAPI.put(oracle.kv.table.Row, oracle.kv.table.ReturnRow, oracle.kv.table.WriteOptions)
.IllegalStateException
- if called on a Row that has an undefined
expiration time, which is a Row that has not been put or retrieved via
a get or iterator operationCopyright (c) 2011, 2017 Oracle and/or its affiliates. All rights reserved.