Trait

com.intenthq.pucket

PucketCompanion

Related Doc: package pucket

Permalink

trait PucketCompanion extends AnyRef

Trait for using with Pucket implementations' companion objects describes functions for creating, or finding puckets on a filesystem

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PucketCompanion
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type DescriptorType[T <: HigherType] <: PucketDescriptor[T]

    Permalink
  2. abstract type HigherType

    Permalink
  3. abstract type V

    Permalink

Abstract Value Members

  1. abstract def apply[T <: HigherType](path: Path, fs: FileSystem, other: V, blockSize: Int): \/[Throwable, Pucket[T]]

    Permalink

    Find an existing pucket on the filesystem

    Find an existing pucket on the filesystem

    T

    the expected type of the pucket data

    path

    the path to the pucket

    fs

    hadoop filesystem instance

    other

    the implementing object's parameter for verifying the found pucket matches expect format

    blockSize

    the size of a parquet block before memory is flushed

    returns

    an error if any of the validation fails or the pucket

  2. abstract def create[T <: HigherType](path: Path, fs: FileSystem, descriptor: DescriptorType[T], blockSize: Int = defaultBlockSize): \/[Throwable, Pucket[T]]

    Permalink

    Create a new pucket

    Create a new pucket

    T

    the type of the pucket data

    path

    the path to the pucket

    fs

    hadoop filesystem instance

    descriptor

    a descriptor to create a new pucket with

    blockSize

    the size of a parquet block before memory is flushed

    returns

    an error if any of the validation fails or the new pucket

  3. abstract def getDescriptor[T <: HigherType](schemaSpec: V, compression: CompressionCodecName, partitioner: Option[PucketPartitioner[T]]): DescriptorType[T]

    Permalink

    Returns a descriptor of the correct type

  4. abstract def getDescriptorSchemaSpec[T <: HigherType](descriptor: DescriptorType[T]): V

    Permalink

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def create[T <: HigherType](path: Path, fs: FileSystem, schemaSpec: V, compression: CompressionCodecName, partitioner: Option[PucketPartitioner[T]]): \/[Throwable, Pucket[T]]

    Permalink

    Create a new pucket

    Create a new pucket

    T

    the expected type of the pucket data

    path

    the path to the pucket

    fs

    hadoop filesystem instance

    schemaSpec

    schema for the data type

    compression

    parquet compression codec to use

    partitioner

    optional partitioning scheme

    returns

    an error if any of the validation fails or the new pucket

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def findOrCreate[T <: HigherType](path: Path, fs: FileSystem, schemaSpec: V, compression: CompressionCodecName, partitioner: Option[PucketPartitioner[T]]): \/[Throwable, Pucket[T]]

    Permalink
  11. def findOrCreate[T <: HigherType](path: Path, fs: FileSystem, descriptor: DescriptorType[T], blockSize: Int = defaultBlockSize): \/[Throwable, Pucket[T]]

    Permalink
  12. def findOrCreateRetry[T <: HigherType](path: Path, fs: FileSystem, schemaSpec: V, compression: CompressionCodecName, partitioner: Option[PucketPartitioner[T]], attempts: Int, retryIntervalMs: Int): \/[Throwable, Pucket[T]]

    Permalink

    Find an existing pucket or create one if it does not exist

    Find an existing pucket or create one if it does not exist

    T

    the expected type of the pucket data

    path

    the path to the pucket

    fs

    hadoop filesystem instance

    schemaSpec

    schema for the data type

    compression

    parquet compression codec to use

    partitioner

    optional partitioning scheme

    returns

    an error if any of the validation fails or the pucket

  13. def findOrCreateRetry[T <: HigherType](path: Path, fs: FileSystem, descriptor: DescriptorType[T], blockSize: Int = defaultBlockSize, attempts: Int = Pucket.defaultCreationAttempts, retryIntervalMs: Int = Pucket.defaultRetryIntervalMs): \/[Throwable, Pucket[T]]

    Permalink

    Find an existing pucket or create one if it does not exist

    Find an existing pucket or create one if it does not exist

    T

    the expected type of the pucket data

    path

    the path to the pucket

    fs

    hadoop filesystem instance

    descriptor

    a descriptor to create a new pucket with or validate an existing pucket against

    blockSize

    the size of a parquet block before memory is flushed

    returns

    an error if any of the validation fails or the pucket

  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  16. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  21. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped