Packages

c

io.delta.storage

IBMCOSLogStore

class IBMCOSLogStore extends HadoopFileSystemLogStore

:: Unstable ::

LogStore implementation for IBM Cloud Object Storage.

We assume the following from COS's FileSystem implementations: - Write on COS is all-or-nothing, whether overwrite or not. - Write is atomic. Note: Write is atomic when using the Stocator v1.1.1+ - Storage Connector for Apache Spark (https://github.com/CODAIT/stocator) by setting the configuration fs.cos.atomic.write to true (for more info see the documentation for Stocator) - List-after-write is consistent.

Annotations
@Unstable()
Note

This class is not meant for direct access but for configuration based on storage system. See https://docs.delta.io/latest/delta-storage.html for details.

Linear Supertypes
HadoopFileSystemLogStore, org.apache.spark.sql.delta.storage.LogStore, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IBMCOSLogStore
  2. HadoopFileSystemLogStore
  3. LogStore
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IBMCOSLogStore(sparkConf: SparkConf, initHadoopConf: Configuration)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def createTempPath(path: Path): Path
    Attributes
    protected
    Definition Classes
    HadoopFileSystemLogStore
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def getHadoopConfiguration: Configuration
    Attributes
    protected
    Definition Classes
    HadoopFileSystemLogStore
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def invalidateCache(): Unit

    Invalidate any caching that the implementation may be using

    Invalidate any caching that the implementation may be using

    Definition Classes
    IBMCOSLogStore → HadoopFileSystemLogStore → LogStore
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. def isPartialWriteVisible(path: Path, hadoopConf: Configuration): Boolean

    Whether a partial write is visible when writing to path.

    Whether a partial write is visible when writing to path.

    As this depends on the underlying file system implementations, we require the input of path here in order to identify the underlying file system, even though in most cases a log store only deals with one file system.

    The default value is only provided here for legacy reasons, which will be removed. Any LogStore implementation should override this instead of relying on the default.

    Note: The default implementation ignores the hadoopConf parameter to provide the backward compatibility. Subclasses should override this method and use hadoopConf properly to support passing Hadoop file system configurations through DataFrame options.

    Definition Classes
    IBMCOSLogStore → LogStore
  16. def isPartialWriteVisible(path: Path): Boolean

    Whether a partial write is visible when writing to path.

    Whether a partial write is visible when writing to path.

    As this depends on the underlying file system implementations, we require the input of path here in order to identify the underlying file system, even though in most cases a log store only deals with one file system.

    The default value is only provided here for legacy reasons, which will be removed. Any LogStore implementation should override this instead of relying on the default.

    Definition Classes
    IBMCOSLogStore → LogStore
  17. def listFrom(path: Path, hadoopConf: Configuration): Iterator[FileStatus]

    List the paths in the same directory that are lexicographically greater or equal to (UTF-8 sorting) the given path.

    List the paths in the same directory that are lexicographically greater or equal to (UTF-8 sorting) the given path. The result should also be sorted by the file name.

    Note: The default implementation ignores the hadoopConf parameter to provide the backward compatibility. Subclasses should override this method and use hadoopConf properly to support passing Hadoop file system configurations through DataFrame options.

    Definition Classes
    HadoopFileSystemLogStore → LogStore
  18. def listFrom(path: Path): Iterator[FileStatus]

    List the paths in the same directory that are lexicographically greater or equal to (UTF-8 sorting) the given path.

    List the paths in the same directory that are lexicographically greater or equal to (UTF-8 sorting) the given path. The result should also be sorted by the file name.

    Definition Classes
    HadoopFileSystemLogStore → LogStore
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. val preconditionFailedExceptionMessage: String
  23. def read(path: Path, hadoopConf: Configuration): Seq[String]

    Load the given file and return a Seq of lines.

    Load the given file and return a Seq of lines. The line break will be removed from each line. This method will load the entire file into the memory. Call readAsIterator if possible as its implementation may be more efficient.

    Note: The default implementation ignores the hadoopConf parameter to provide the backward compatibility. Subclasses should override this method and use hadoopConf properly to support passing Hadoop file system configurations through DataFrame options.

    Definition Classes
    HadoopFileSystemLogStore → LogStore
  24. def read(path: Path): Seq[String]

    Load the given file and return a Seq of lines.

    Load the given file and return a Seq of lines. The line break will be removed from each line. This method will load the entire file into the memory. Call readAsIterator if possible as its implementation may be more efficient.

    Definition Classes
    HadoopFileSystemLogStore → LogStore
  25. def readAsIterator(path: Path, hadoopConf: Configuration): ClosableIterator[String]

    Load the given file and return an iterator of lines.

    Load the given file and return an iterator of lines. The line break will be removed from each line. The default implementation calls read to load the entire file into the memory. An implementation should provide a more efficient approach if possible. For example, the file content can be loaded on demand.

    Note: the returned ClosableIterator should be closed when it's no longer used to avoid resource leak.

    Note: The default implementation ignores the hadoopConf parameter to provide the backward compatibility. Subclasses should override this method and use hadoopConf properly to support passing Hadoop file system configurations through DataFrame options.

    Definition Classes
    HadoopFileSystemLogStore → LogStore
  26. def readAsIterator(path: Path): ClosableIterator[String]

    Load the given file and return an iterator of lines.

    Load the given file and return an iterator of lines. The line break will be removed from each line. The default implementation calls read to load the entire file into the memory. An implementation should provide a more efficient approach if possible. For example, the file content can be loaded on demand.

    Note: the returned ClosableIterator should be closed when it's no longer used to avoid resource leak.

    Definition Classes
    HadoopFileSystemLogStore → LogStore
  27. def resolvePathOnPhysicalStorage(path: Path, hadoopConf: Configuration): Path

    Resolve the fully qualified path for the given path.

    Resolve the fully qualified path for the given path.

    Note: The default implementation ignores the hadoopConf parameter to provide the backward compatibility. Subclasses should override this method and use hadoopConf properly to support passing Hadoop file system configurations through DataFrame options.

    Definition Classes
    HadoopFileSystemLogStore → LogStore
  28. def resolvePathOnPhysicalStorage(path: Path): Path

    Resolve the fully qualified path for the given path.

    Resolve the fully qualified path for the given path.

    Definition Classes
    HadoopFileSystemLogStore → LogStore
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  34. def write(path: Path, actions: Iterator[String], overwrite: Boolean, hadoopConf: Configuration): Unit

    Write the given actions to the given path with or without overwrite as indicated.

    Write the given actions to the given path with or without overwrite as indicated. Implementation must throw java.nio.file.FileAlreadyExistsException exception if the file already exists and overwrite = false. Furthermore, implementation must ensure that the entire file is made visible atomically, that is, it should not generate partial files.

    Note: The default implementation ignores the hadoopConf parameter to provide the backward compatibility. Subclasses should override this method and use hadoopConf properly to support passing Hadoop file system configurations through DataFrame options.

    Definition Classes
    IBMCOSLogStore → LogStore
  35. def write(path: Path, actions: Iterator[String], overwrite: Boolean = false): Unit

    Write the given actions to the given path with or without overwrite as indicated.

    Write the given actions to the given path with or without overwrite as indicated. Implementation must throw java.nio.file.FileAlreadyExistsException exception if the file already exists and overwrite = false. Furthermore, implementation must ensure that the entire file is made visible atomically, that is, it should not generate partial files.

    Definition Classes
    IBMCOSLogStore → LogStore
  36. def writeWithRename(path: Path, actions: Iterator[String], overwrite: Boolean, hadoopConf: Configuration): Unit

    An internal write implementation that uses FileSystem.rename().

    An internal write implementation that uses FileSystem.rename().

    This implementation should only be used for the underlying file systems that support atomic renames, e.g., Azure is OK but HDFS is not.

    Attributes
    protected
    Definition Classes
    HadoopFileSystemLogStore

Deprecated Value Members

  1. final def listFrom(path: String): Iterator[FileStatus]

    List the paths in the same directory that are lexicographically greater or equal to (UTF-8 sorting) the given path.

    List the paths in the same directory that are lexicographically greater or equal to (UTF-8 sorting) the given path. The result should also be sorted by the file name.

    Definition Classes
    LogStore
    Annotations
    @deprecated
    Deprecated

    call the method that asks for a Hadoop Configuration object instead

  2. final def read(path: String): Seq[String]

    Load the given file and return a Seq of lines.

    Load the given file and return a Seq of lines. The line break will be removed from each line. This method will load the entire file into the memory. Call readAsIterator if possible as its implementation may be more efficient.

    Definition Classes
    LogStore
    Annotations
    @deprecated
    Deprecated

    call the method that asks for a Hadoop Configuration object instead

  3. final def readAsIterator(path: String): ClosableIterator[String]

    Load the given file and return an iterator of lines.

    Load the given file and return an iterator of lines. The line break will be removed from each line. The default implementation calls read to load the entire file into the memory. An implementation should provide a more efficient approach if possible. For example, the file content can be loaded on demand.

    Definition Classes
    LogStore
    Annotations
    @deprecated
    Deprecated

    call the method that asks for a Hadoop Configuration object instead

  4. final def write(path: String, actions: Iterator[String]): Unit

    Write the given actions to the given path without overwriting any existing file.

    Write the given actions to the given path without overwriting any existing file. Implementation must throw java.nio.file.FileAlreadyExistsException exception if the file already exists. Furthermore, implementation must ensure that the entire file is made visible atomically, that is, it should not generate partial files.

    Definition Classes
    LogStore
    Annotations
    @deprecated
    Deprecated

    call the method that asks for a Hadoop Configuration object instead

  5. def writeWithRename(path: Path, actions: Iterator[String], overwrite: Boolean = false): Unit

    An internal write implementation that uses FileSystem.rename().

    An internal write implementation that uses FileSystem.rename().

    This implementation should only be used for the underlying file systems that support atomic renames, e.g., Azure is OK but HDFS is not.

    Attributes
    protected
    Definition Classes
    HadoopFileSystemLogStore
    Annotations
    @deprecated
    Deprecated

    call the method that asks for a Hadoop Configuration object instead

Inherited from HadoopFileSystemLogStore

Inherited from org.apache.spark.sql.delta.storage.LogStore

Inherited from AnyRef

Inherited from Any

Ungrouped