Package io.oxia.client.api

Interface AsyncOxiaClient

All Superinterfaces:
AutoCloseable
public interface AsyncOxiaClient extends AutoCloseable
Asynchronous client for the Oxia service.

  • Method Details

    • put

      CompletableFuture<PutResult> put(String key, byte[] value, Set<PutOption> options)
      Conditionally associates a value with a key if the server's versionId of the record is as specified, at the instant when the put is applied. The put will not be applied if the server's versionId of the record does not match the expectation set in the call. If you wish the put to succeed only if the key does not already exist on the server, then pass the PutOption.IfRecordDoesNotExist value.
      Parameters:
      key - The key with which the value should be associated.
      value - The value to associate with the key.
      options - Set options for the put.
      Returns:
      The result of the put at the specified key. Supplied via a future that returns the PutResult. The future will complete exceptionally with an UnexpectedVersionIdException if the versionId at the server did not that match supplied in the call.

    • put

      CompletableFuture<PutResult> put(String key, byte[] value)
      Conditionally associates a value with a key if the server's versionId of the record is as specified, at the instant when the put is applied. The put will not be applied if the server's versionId of the record does not match the expectation set in the call.
      Parameters:
      key - The key with which the value should be associated.
      value - The value to associate with the key.
      Returns:
      The result of the put at the specified key. Supplied via a future that returns the PutResult.

    • delete

      CompletableFuture<Boolean> delete(String key, Set<DeleteOption> options)
      Conditionally deletes the record associated with the key if the record exists, and the server's versionId of the record is as specified, at the instant when the delete is applied. The delete will not be applied if the server's versionId of the record does not match the expectation set in the call.
      Parameters:
      key - Deletes the record with the specified key.
      options - Set options for the delete.
      Returns:
      A future that completes when the delete call has returned. The future can return a flag that will be true if the key was actually present on the server, false otherwise. The future will complete exceptionally with an UnexpectedVersionIdException the versionId at the server did not that match supplied in the call.

    • delete

      CompletableFuture<Boolean> delete(String key)
      Unconditionally deletes the record associated with the key if the record exists.
      Parameters:
      key - Deletes the record with the specified key.
      Returns:
      A future that completes when the delete call has returned. The future can return a flag that will be true if the key was actually present on the server, false otherwise.

    • deleteRange

      CompletableFuture<Void> deleteRange(String startKeyInclusive, String endKeyExclusive)
      Deletes any records with keys within the specified range. For more information on how keys are sorted, check the relevant section in the Oxia documentation.
      Parameters:
      startKeyInclusive - The key that declares start of the range, and is included from the range.
      endKeyExclusive - The key that declares the end of the range, and is excluded from the range.
      Returns:
      A future that completes when the delete call has returned.

    • deleteRange

      CompletableFuture<Void> deleteRange(String startKeyInclusive, String endKeyExclusive, Set<DeleteRangeOption> options)
      Deletes any records with keys within the specified range. For more information on how keys are sorted, check the relevant section in the Oxia documentation.
      Parameters:
      startKeyInclusive - The key that declares start of the range, and is included from the range.
      endKeyExclusive - The key that declares the end of the range, and is excluded from the range.
      options - Set options for the delete range.
      Returns:
      A future that completes when the delete call has returned.

    • get

      CompletableFuture<GetResult> get(String key)
      Returns the record associated with the specified key. The returned value includes the value, and other metadata.
      Parameters:
      key - The key associated with the record to be fetched.
      Returns:
      The value associated with the supplied key, or null if the key did not exist. Supplied via a future returning a GetResult.

    • get

      CompletableFuture<GetResult> get(String key, Set<GetOption> options)
      Returns the record associated with the specified key. The returned value includes the value, and other metadata.
      Parameters:
      key - The key associated with the record to be fetched.
      options - Set options for the get operation.
      Returns:
      The value associated with the supplied key, or null if the key did not exist. Supplied via a future returning a GetResult.

    • list

      CompletableFuture<List<String>> list(String startKeyInclusive, String endKeyExclusive)
      Lists any existing keys within the specified range. For more information on how keys are sorted, check the relevant section in the Oxia documentation.
      Parameters:
      startKeyInclusive - The key that declares start of the range, and is included from the range.
      endKeyExclusive - The key that declares the end of the range, and is excluded from the range.
      Returns:
      The list of keys that exist within the specified range or an empty list if there were none. Supplied via a future.

    • list

      CompletableFuture<List<String>> list(String startKeyInclusive, String endKeyExclusive, Set<ListOption> options)
      Lists any existing keys within the specified range. For more information on how keys are sorted, check the relevant section in the Oxia documentation.
      Parameters:
      startKeyInclusive - The key that declares start of the range, and is included from the range.
      endKeyExclusive - The key that declares the end of the range, and is excluded from the range.
      options - Set options for the list operation.
      Returns:
      The list of keys that exist within the specified range or an empty list if there were none. Supplied via a future.

    • rangeScan

      void rangeScan(String startKeyInclusive, String endKeyExclusive, RangeScanConsumer consumer)
      Scan any existing records within the specified range of keys.
      Parameters:
      startKeyInclusive - The key that declares start of the range, and is included from the range.
      endKeyExclusive - The key that declares the end of the range, and is excluded from the range.
      consumer - A RangeScanConsumer that will be invoked with the records or errors.

    • rangeScan

      void rangeScan(String startKeyInclusive, String endKeyExclusive, RangeScanConsumer consumer, Set<RangeScanOption> options)
      Scan any existing records within the specified range of keys.
      Parameters:
      startKeyInclusive - The key that declares start of the range, and is included from the range.
      endKeyExclusive - The key that declares the end of the range, and is excluded from the range.
      consumer - A RangeScanConsumer that will be invoked with the records or errors.
      options - the range scan options

    • notifications

      void notifications(Consumer<Notification> notificationCallback)
      Registers a callback to receive Oxia record change notifications. Multiple callbacks can be registered.
      Parameters:
      notificationCallback - A callback to receive notifications.

    • getSequenceUpdates

      Closeable getSequenceUpdates(String key, Consumer<String> listener, Set<GetSequenceUpdatesOption> options)
      GetSequenceUpdates allows to subscribe to the updates happening on a sequential key The channel will report the current latest sequence for a given key. Multiple updates can be collapsed into one single event with the highest sequence.
      Parameters:
      key - The key to subscribe to.
      listener - The listener to receive the updates.
      options - The options to use for the subscription.
      Returns:
      A handle to close the subscription.