Object/Trait

com.snowplowanalytics.iglu.schemaddl.migrations

SchemaList

Related Docs: trait SchemaList | package migrations

Permalink

object SchemaList extends Serializable

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SchemaList
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait BuildError extends Product with Serializable

    Permalink

    SchemaList construction errors

  2. sealed abstract case class Full extends SchemaList with Product with Serializable

    Permalink

    Multiple schemas, grouped by model and in canonical order

  3. sealed abstract case class ModelGroupSet extends Product with Serializable

    Permalink

    Has all properties of SchemaList.Full, except canonical order

  4. sealed abstract case class Segment extends Product with Serializable

    Permalink

    Has all properties of SchemaList.Full, except absence of gaps

  5. sealed abstract case class Single extends SchemaList with Product with Serializable

    Permalink

    Single init schema (e.g.

    Single init schema (e.g. 1-0-0, 3-0-0). No migrations should be involved

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. object BuildError extends Serializable

    Permalink

  5. object Full extends Serializable

    Permalink

  6. object ModelGroupSet extends Serializable

    Permalink

  7. object Segment extends Serializable

    Permalink

  8. object Single extends Serializable

    Permalink

  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  10. def buildMultiple(schemas: NonEmptyList[IgluSchema]): Ior[NonEmptyList[BuildError], NonEmptyList[SchemaList]]

    Permalink

    Construct SchemaLists from unordered list

    Construct SchemaLists from unordered list

    schemas

    non-empty list of schemas which can belong to different model groups

    returns

    non-empty list of errors while creating SchemaLists in Ior.left and non-empty list of SchemaList which created from given schemas in Ior.right

  11. def buildSingleSchema(schema: IgluSchema): Option[SchemaList]

    Permalink

    Construct SingleSchema from given Schema if it is first version of its model group

    Construct SingleSchema from given Schema if it is first version of its model group

    schema

    IgluSchems to create SingleSchema

    returns

    None if given schema is not first version of its model group Some(SingleSchema(schema)) otherwise

  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. def fromFetchedSchemas[F[_], E](fetch: EitherT[F, E, NonEmptyList[IgluSchema]])(implicit arg0: Functor[F]): EitherT[F, E, NonEmptyList[SchemaList]]

    Permalink

    Build SchemaLists from fetched IgluSchemas.

    Build SchemaLists from fetched IgluSchemas. Given EitherT should wrap fetching schemas from /schemas endpoint of Iglu Server because they need to ordered.

    fetch

    EitherT which wraps list of ordered Iglu Schemas

    returns

    list of SchemaLists which created from fetched schemas

  17. def fromSchemaList[F[_], E](keys: core.SchemaList, fetch: (SchemaKey) ⇒ EitherT[F, E, IgluSchema])(implicit arg0: Monad[F]): EitherT[F, E, SchemaList]

    Permalink

    Fetch from Iglu Server and parse each schema from SchemaKeyList, using generic resolution function (IO-dependent) valid constructor of SchemaList

    Fetch from Iglu Server and parse each schema from SchemaKeyList, using generic resolution function (IO-dependent) valid constructor of SchemaList

    keys

    non-empty properly ordered list of SchemaKeys, fetched from Iglu Server

    fetch

    resolution function

    returns

    properly ordered list of parsed JSON Schemas

  18. def fromUnambiguous(modelGroup: ModelGroupSet): Either[BuildError, SchemaList]

    Permalink

    Construct SchemaList from list of schemas, but only if order is unambiguous and no gaps If order is ambiguous (left returned) then the only safe order can be retrieved from Iglu Server (by fromSchemaList), use other constructors on your own risk

    Construct SchemaList from list of schemas, but only if order is unambiguous and no gaps If order is ambiguous (left returned) then the only safe order can be retrieved from Iglu Server (by fromSchemaList), use other constructors on your own risk

    modelGroup

    non-empty list of schema belonging to the same ModelGroup

    returns

    error object as Either.left in case of transformation is not successful or created SchemaList as Either.right if everything is okay

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

    Permalink
    Definition Classes
    AnyRef → Any

  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  22. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  26. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  27. def unsafeBuildWithReorder(modelGroup: ModelGroupSet): Either[BuildError, SchemaList]

    Permalink

    Construct SchemaList from list of schemas, if there is no gaps.

    Construct SchemaList from list of schemas, if there is no gaps. Order given model group according to their schema key and resulting ordering might not be correct if given schema list ambiguous therefore it is not safe to use this function with ambiguous schema list.

    modelGroup

    non-empty list of schema belonging to the same ModelGroup

    returns

    error object as Either.left in case of transformation is not successful or created SchemaList as Either.right if everything is okay

  28. final def wait(): Unit

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

  29. final def wait(arg0: Long, arg1: Int): Unit

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

  30. final def wait(arg0: Long): Unit

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

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped