Package com.apple.foundationdb.relational.recordlayer

Interface DirectScannable

All Known Subinterfaces:
Index, Table
All Known Implementing Classes:
RecordStoreIndex, RecordTypeScannable, RecordTypeTable
public interface DirectScannable

  • Method Summary

    Modifier and Type
    Method
    Description
    com.apple.foundationdb.relational.api.Row
    get(Transaction t, com.apple.foundationdb.relational.api.Row key, com.apple.foundationdb.relational.api.Options options)
     
    KeyBuilder
    getKeyBuilder()
     
    com.apple.foundationdb.relational.api.StructMetaData
    getMetaData()
     
    String
    getName()
    If table, returns the table name or index name if it is an index.
    ResumableIterator<com.apple.foundationdb.relational.api.Row>
    openScan(com.apple.foundationdb.relational.api.Row keyPrefix, com.apple.foundationdb.relational.api.Options options)
    Open a scan against this entity.
    void
    validate(com.apple.foundationdb.relational.api.Options scanOptions)
    Validate that this Scannable is able to satisfy the query options that are presented to it.

  • Method Details

    • validate

      void validate(com.apple.foundationdb.relational.api.Options scanOptions) throws com.apple.foundationdb.relational.api.exceptions.RelationalException
      Validate that this Scannable is able to satisfy the query options that are presented to it. This is present so that high level operations can fail quickly with different types of Unsupported errors, rather than throwing something which is not as useful.
      Parameters:
      scanOptions - the options for the scan/get.
      Throws:
      com.apple.foundationdb.relational.api.exceptions.RelationalException - if the options are not supported by this scannable.

    • openScan

      ResumableIterator<com.apple.foundationdb.relational.api.Row> openScan(@Nullable com.apple.foundationdb.relational.api.Row keyPrefix, @Nonnull com.apple.foundationdb.relational.api.Options options) throws com.apple.foundationdb.relational.api.exceptions.RelationalException
      Open a scan against this entity.
      Parameters:
      keyPrefix - the key prefix to use for the scan
      options - the options for the scan
      Returns:
      a Scanner over the range of records that share the same prefix keyPrefix, with the specified options.
      Throws:
      com.apple.foundationdb.relational.api.exceptions.RelationalException - if something goes wrong during scanning.

    • get

      com.apple.foundationdb.relational.api.Row get(@Nonnull Transaction t, @Nonnull com.apple.foundationdb.relational.api.Row key, @Nonnull com.apple.foundationdb.relational.api.Options options) throws com.apple.foundationdb.relational.api.exceptions.RelationalException
      Throws:
      com.apple.foundationdb.relational.api.exceptions.RelationalException

    • getKeyBuilder

      KeyBuilder getKeyBuilder() throws com.apple.foundationdb.relational.api.exceptions.RelationalException
      Throws:
      com.apple.foundationdb.relational.api.exceptions.RelationalException

    • getName

      @Nonnull String getName()
      If table, returns the table name or index name if it is an index.
      Returns:
      the table name if it is a table, or index name if it is an index

    • getMetaData

      com.apple.foundationdb.relational.api.StructMetaData getMetaData() throws com.apple.foundationdb.relational.api.exceptions.RelationalException
      Throws:
      com.apple.foundationdb.relational.api.exceptions.RelationalException