SchemaKey

object SchemaKey

Companion object, which contains a custom constructor for SchemaKey.

Companion:
class
trait Product
trait Mirror
class Object
trait Matchable
class Any

Type members

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Inherited from:
Mirror

Value members

Concrete methods

def extract[E : ExtractSchemaKey](e: E): Either[ParseError, SchemaKey]

Extract a SchemaKey from an entity with base type E, representing a piece of self-describing data.

Extract a SchemaKey from an entity with base type E, representing a piece of self-describing data.

def fromUri(schemaUri: String): Either[ParseError, SchemaKey]

A custom constructor for a SchemaKey from an Iglu schema URI, which looks like: "iglu:com.vendor/schema_name/jsonschema/1-0-0".

A custom constructor for a SchemaKey from an Iglu schema URI, which looks like: "iglu:com.vendor/schema_name/jsonschema/1-0-0".

An Iglu schema URI is the default for schema lookup.

Value parameters:
schemaUri

An Iglu schema URI.

Returns:

A SchemaKey or an error.

Concrete fields

val ordering: Ordering[SchemaKey]

A Default Ordering instance for a SchemaKey, which sorts keys alphabetically AND by ascending SchemaVer.

A Default Ordering instance for a SchemaKey, which sorts keys alphabetically AND by ascending SchemaVer.

Usage:

 import com.snowplowanalytics.iglu.core.SchemaKey
 implicit val schemaOrdering = SchemaKey.ordering
 keys.sorted
val schemaUriRegex: Regex

Canonical regular expression for a SchemaKey.

Canonical regular expression for a SchemaKey.