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.
- Alphabetic
- By Inheritance
- IBMCOSLogStore
- HadoopFileSystemLogStore
- LogStore
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new IBMCOSLogStore(sparkConf: SparkConf, hadoopConf: Configuration)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
createTempPath(path: Path): Path
- Attributes
- protected
- Definition Classes
- HadoopFileSystemLogStore
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getHadoopConfiguration: Configuration
- Attributes
- protected
- Definition Classes
- HadoopFileSystemLogStore
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
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
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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
-
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
-
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
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val preconditionFailedExceptionMessage: String
-
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. CallreadAsIterator
if possible as its implementation may be more efficient.- Definition Classes
- HadoopFileSystemLogStore → LogStore
-
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. CallreadAsIterator
if possible as its implementation may be more efficient.- Definition Classes
- LogStore
-
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
-
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
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
write(path: Path, actions: Iterator[String], overwrite: Boolean = false): Unit
Write the given
actions
to the givenpath
with or without overwrite as indicated.Write the given
actions
to the givenpath
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
-
final
def
write(path: String, actions: Iterator[String]): Unit
Write the given
actions
to the givenpath
without overwriting any existing file.Write the given
actions
to the givenpath
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
-
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