# Uses of Interface
oracle.kv.table.PrimaryKey

Packages that use PrimaryKey
Package
Description
oracle.kv.hadoop.table
Support for running MapReduce jobs against data written to an Oracle NoSQL Database via the Table API.
oracle.kv.pubsub
Provides the classes used to define a Subscription to all logical changes (table row puts and deletes) made to a NoSQL store.
oracle.kv.table
Table support for Oracle NoSQL Database.

- ## Uses of PrimaryKey in oracle.kv.hadoop.table

  Methods in oracle.kv.hadoop.table that return PrimaryKey
  Modifier and Type
  Method
  Description
  `PrimaryKey`
  TableRecordReader.`getCurrentKey()`
  Get the current key.
  Methods in oracle.kv.hadoop.table that return types with arguments of type PrimaryKey
  Modifier and Type
  Method
  Description
  `RecordReader<PrimaryKey,Row>`
  TableInputFormat.`createRecordReader(InputSplit split, TaskAttemptContext context)`
  Returns the RecordReader for the given InputSplit.

- ## Uses of PrimaryKey in oracle.kv.pubsub

  Methods in oracle.kv.pubsub that return PrimaryKey
  Modifier and Type
  Method
  Description
  `PrimaryKey`
  StreamOperation.DeleteEvent.`getPrimaryKey()`
  Returns the primary key associated with the delete operation.

- ## Uses of PrimaryKey in oracle.kv.table

  Methods in oracle.kv.table that return PrimaryKey
  Modifier and Type
  Method
  Description
  `PrimaryKey`
  FieldValue.`asPrimaryKey()`
  Casts to PrimaryKey.
  `PrimaryKey`
  PrimaryKey.`clone()`
  Returns a deep copy of this object.
  `PrimaryKey`
  Row.`createPrimaryKey()`
  Creates a PrimaryKey from this Row.
  `PrimaryKey`
  Table.`createPrimaryKey()`
  Creates an empty `PrimaryKey` for the table that can only hold fields that are part of the primary key for the table.
  `PrimaryKey`
  Table.`createPrimaryKey(RecordValue value)`
  Creates a `PrimaryKey` for the table populated with relevant fields from the `RecordValue` parameter.
  `PrimaryKey`
  Table.`createPrimaryKeyFromJson(InputStream jsonInput, boolean exact)`
  Creates a `PrimaryKey` based on JSON input.
  `PrimaryKey`
  Table.`createPrimaryKeyFromJson(String jsonInput, boolean exact)`
  Creates a `PrimaryKey` based on JSON input.
  `PrimaryKey`
  KeyPair.`getPrimaryKey()`
  Returns the PrimaryKey from the pair.
  `PrimaryKey`
  TableOperation.`getPrimaryKey()`
  Returns the PrimaryKey associated with the operation if it is a delete operation, otherwise return null.
  Methods in oracle.kv.table that return types with arguments of type PrimaryKey
  Modifier and Type
  Method
  Description
  `List<PrimaryKey>`
  TableAPI.`multiGetKeys(PrimaryKey key, MultiRowOptions getOptions, ReadOptions readOptions)`
  Return the keys associated with a partial primary key in an atomic manner.
  `CompletableFuture<List<PrimaryKey>>`
  TableAPI.`multiGetKeysAsync(PrimaryKey key, MultiRowOptions getOptions, ReadOptions readOptions)`
  Return the keys associated with a partial primary key in an atomic manner, returning a future to manage the asynchronous operation.
  `TableIterator<PrimaryKey>`
  TableAPI.`tableKeysIterator(Iterator<PrimaryKey> primaryKeyIterator, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns an iterator over the keys matching the primary keys supplied by iterator (or the rows in ancestor or descendant tables, or those in a range specified by the MultiRowOptions argument).
  `TableIterator<PrimaryKey>`
  TableAPI.`tableKeysIterator(List<Iterator<PrimaryKey>> primaryKeyIterators, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns an iterator over the keys matching the primary keys supplied by iterator (or the rows in ancestor or descendant tables, or those in a range specified by the MultiRowOptions argument).
  `TableIterator<PrimaryKey>`
  TableAPI.`tableKeysIterator(PrimaryKey key, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns an iterator over the keys associated with a partial primary key.
  `Publisher<PrimaryKey>`
  TableAPI.`tableKeysIteratorAsync(Iterator<PrimaryKey> primaryKeyIterator, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns a publisher that can be used to subscribe to the results of an asynchronous iteration over the keys matching the primary keys supplied by iterator (or the rows in ancestor or descendant tables, or those in a range specified by the MultiRowOptions argument).
  `Publisher<PrimaryKey>`
  TableAPI.`tableKeysIteratorAsync(List<Iterator<PrimaryKey>> primaryKeyIterators, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns a publisher that can be used to subscribe to the results of an asynchronous iteration over the keys matching the primary keys supplied by iterator (or the rows in ancestor or descendant tables, or those in a range specified by the MultiRowOptions argument).
  `Publisher<PrimaryKey>`
  TableAPI.`tableKeysIteratorAsync(PrimaryKey key, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns a publisher that can be used to subscribe to the results an asynchronous iteration over the keys associated with a partial primary key.
  Methods in oracle.kv.table with parameters of type PrimaryKey
  Modifier and Type
  Method
  Description
  `TableOperation`
  TableOperationFactory.`createDelete(PrimaryKey key, ReturnRow.Choice prevReturn, boolean abortIfUnsuccessful)`
  Create a Delete operation suitable for use as an argument to the `execute` method.
  `TableOperation`
  TableOperationFactory.`createDeleteIfVersion(PrimaryKey key, Version versionMatch, ReturnRow.Choice prevReturn, boolean abortIfUnsuccessful)`
  Create a Delete operation suitable for use as an argument to the `execute` method.
  `boolean`
  TableAPI.`delete(PrimaryKey key, ReturnRow prevRow, WriteOptions writeOptions)`
  Deletes a row from a table.
  `CompletableFuture<Boolean>`
  TableAPI.`deleteAsync(PrimaryKey key, ReturnRow prevRow, WriteOptions writeOptions)`
  Deletes a row from a table, returning a future to manage the asynchronous operation.
  `boolean`
  TableAPI.`deleteIfVersion(PrimaryKey key, Version matchVersion, ReturnRow prevRow, WriteOptions writeOptions)`
  Deletes a row from a table but only if its version matches the one specified in matchVersion.
  `CompletableFuture<Boolean>`
  TableAPI.`deleteIfVersionAsync(PrimaryKey key, Version matchVersion, ReturnRow prevRow, WriteOptions writeOptions)`
  Deletes a row from a table, but only if its version matches the one specified in `matchVersion`, returning a future to manage the asynchronous operation.
  `Row`
  TableAPI.`get(PrimaryKey key, ReadOptions readOptions)`
  Gets the `Row` associated with the primary key.
  `CompletableFuture<Row>`
  TableAPI.`getAsync(PrimaryKey key, ReadOptions readOptions)`
  Gets the `Row` associated with the primary key, returning a future to manage the asynchronous operation.
  `int`
  TableAPI.`multiDelete(PrimaryKey key, MultiRowOptions getOptions, WriteOptions writeOptions)`
  Deletes multiple rows from a table in an atomic operation.
  `CompletableFuture<Integer>`
  TableAPI.`multiDeleteAsync(PrimaryKey key, MultiRowOptions getOptions, WriteOptions writeOptions)`
  Deletes multiple rows from a table in an atomic operation, returning a future to manage the asynchronous operation.
  `List<Row>`
  TableAPI.`multiGet(PrimaryKey key, MultiRowOptions getOptions, ReadOptions readOptions)`
  Returns the rows associated with a partial primary key in an atomic manner.
  `CompletableFuture<List<Row>>`
  TableAPI.`multiGetAsync(PrimaryKey key, MultiRowOptions getOptions, ReadOptions readOptions)`
  Returns the rows associated with a partial primary key in an atomic manner, returning a future to manage the asynchronous operation.
  `List<PrimaryKey>`
  TableAPI.`multiGetKeys(PrimaryKey key, MultiRowOptions getOptions, ReadOptions readOptions)`
  Return the keys associated with a partial primary key in an atomic manner.
  `CompletableFuture<List<PrimaryKey>>`
  TableAPI.`multiGetKeysAsync(PrimaryKey key, MultiRowOptions getOptions, ReadOptions readOptions)`
  Return the keys associated with a partial primary key in an atomic manner, returning a future to manage the asynchronous operation.
  `TableIterator<Row>`
  TableAPI.`tableIterator(PrimaryKey key, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns an iterator over the rows associated with a partial primary key.
  `Publisher<Row>`
  TableAPI.`tableIteratorAsync(PrimaryKey key, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns a publisher that can be used to subscribe to the results of an asynchronous iteration over the rows associated with a partial primary key.
  `TableIterator<PrimaryKey>`
  TableAPI.`tableKeysIterator(PrimaryKey key, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns an iterator over the keys associated with a partial primary key.
  `Publisher<PrimaryKey>`
  TableAPI.`tableKeysIteratorAsync(PrimaryKey key, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns a publisher that can be used to subscribe to the results an asynchronous iteration over the keys associated with a partial primary key.
  Method parameters in oracle.kv.table with type arguments of type PrimaryKey
  Modifier and Type
  Method
  Description
  `TableIterator<Row>`
  TableAPI.`tableIterator(Iterator<PrimaryKey> primaryKeyIterator, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns an iterator over the rows matching the primary keys supplied by iterator (or the rows in ancestor or descendant tables, or those in a range specified by the MultiRowOptions argument).
  `TableIterator<Row>`
  TableAPI.`tableIterator(List<Iterator<PrimaryKey>> primaryKeyIterators, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns an iterator over the rows matching the primary keys supplied by iterator (or the rows in ancestor or descendant tables, or those in a range specified by the MultiRowOptions argument).
  `Publisher<Row>`
  TableAPI.`tableIteratorAsync(Iterator<PrimaryKey> primaryKeyIterator, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns a publisher that can be used to subscribe to the results of an asynchronous iteration over the rows matching the primary keys supplied by iterator (or the rows in ancestor or descendant tables, or those in a range specified by the MultiRowOptions argument).
  `Publisher<Row>`
  TableAPI.`tableIteratorAsync(List<Iterator<PrimaryKey>> primaryKeyIterators, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns a publisher that can be used to subscribe to the results of an asynchronous iteration over the rows matching the primary keys supplied by iterator (or the rows in ancestor or descendant tables, or those in a range specified by the MultiRowOptions argument).
  `TableIterator<PrimaryKey>`
  TableAPI.`tableKeysIterator(Iterator<PrimaryKey> primaryKeyIterator, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns an iterator over the keys matching the primary keys supplied by iterator (or the rows in ancestor or descendant tables, or those in a range specified by the MultiRowOptions argument).
  `TableIterator<PrimaryKey>`
  TableAPI.`tableKeysIterator(List<Iterator<PrimaryKey>> primaryKeyIterators, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns an iterator over the keys matching the primary keys supplied by iterator (or the rows in ancestor or descendant tables, or those in a range specified by the MultiRowOptions argument).
  `Publisher<PrimaryKey>`
  TableAPI.`tableKeysIteratorAsync(Iterator<PrimaryKey> primaryKeyIterator, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns a publisher that can be used to subscribe to the results of an asynchronous iteration over the keys matching the primary keys supplied by iterator (or the rows in ancestor or descendant tables, or those in a range specified by the MultiRowOptions argument).
  `Publisher<PrimaryKey>`
  TableAPI.`tableKeysIteratorAsync(List<Iterator<PrimaryKey>> primaryKeyIterators, MultiRowOptions getOptions, TableIteratorOptions iterateOptions)`
  Returns a publisher that can be used to subscribe to the results of an asynchronous iteration over the keys matching the primary keys supplied by iterator (or the rows in ancestor or descendant tables, or those in a range specified by the MultiRowOptions argument).