org.partiql.lang.schemadiscovery.SchemaInferencerFromExample.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of partiql-lang-kotlin Show documentation

An implementation of PartiQL for the JVM written in Kotlin.

There is a newer version: 1.0.0-perf.1

package org.partiql.lang.schemadiscovery

import com.amazon.ion.IonReader
import org.partiql.ionschema.model.IonSchemaModel

/**
 * Infers a basic schema from a sequence of example data.
 */
interface SchemaInferencerFromExample {
    /**
     * Infers an [IonSchemaModel.Schema] from an [IonReader] using [maxExampleCount] examples.
     *
     * If a non-null [definiteISL] is provided, the discovered schema will also be unified with the definite schema.
     */
    fun inferFromExamples(reader: IonReader, maxExampleCount: Int, definiteISL: IonSchemaModel.Schema? = null): IonSchemaModel.Schema
}