ProviderCapabilities

classin packageklyn.data.spi

public final class ProviderCapabilities:

Immutable, machine-readable capability set published by one provider.

Capability validation occurs before a provider opens a connection, file or cursor. This prevents an unsupported plan from failing after partial output.

capabilities = repository.providerCapabilities()
assert capabilities.supports(ProviderCapability.FILTERING)

Properties

Modifier and Type	Member	Description
public readonly property	provider `provider as String`	Stable provider family or dialect name.

Constructors

Modifier and Type	Member	Description
public	ProviderCapabilities `ProviderCapabilities( provider as String, modes as Map<ProviderCapability, ProviderExecutionMode> ):`	Creates an immutable capability set from explicit execution modes.

Methods

Modifier and Type	Member	Description
public static	document `document(provider as String, indexed as Boolean = false) as ProviderCapabilities:`	Creates the read-only, fully buffered document capability set.
public static	memory `memory(provider as String = "memory") as ProviderCapabilities:`	Creates the standard fully local memory-provider capability set.
public	mode `mode(capability as ProviderCapability) as ProviderExecutionMode:`	Returns the declared mode for a capability.
public static	none `none(provider as String = "unknown") as ProviderCapabilities:`	Creates an explicit capability set with no supported operation.
public static	sql `sql( provider as String, rightJoin as Boolean = true, fullOuterJoin as Boolean = true ) as ProviderCapabilities:`	Creates the standard relational SQL-provider capability set.
public	supports `supports(capability as ProviderCapability) as Boolean:`	Tests whether the provider supports a capability in any execution mode.
public	validate `validate(plan as QueryPlanView) as Void:`	Validates every feature required by a public plan view.