Documentation
¶
Index ¶
- Constants
- func IsSupportedQueryOperationType(operationType string) bool
- func SinkBackendForOperationType(operationType string) (model.SinkBackend, bool)
- func SinkReplayStrategyStrings() []string
- func SupportsIncrementalSourceCheckpointKind(operationType string, kind model.IncrementalCheckpointKind) bool
- func SupportsSinkReplayStrategy(dsType model.DataSourceType, strategy SinkReplayStrategy) bool
- type Descriptor
- type SchemaFamily
- type SinkPayloadBinding
- type SinkReplayStrategy
- func (i SinkReplayStrategy) IsASinkReplayStrategy() bool
- func (i SinkReplayStrategy) MarshalJSON() ([]byte, error)
- func (i SinkReplayStrategy) MarshalText() ([]byte, error)
- func (i SinkReplayStrategy) String() string
- func (i *SinkReplayStrategy) UnmarshalJSON(data []byte) error
- func (i *SinkReplayStrategy) UnmarshalText(text []byte) error
- type SinkResultCapability
- type SinkResultKind
Constants ¶
const ( OperationTypeSQL = "sql" OperationTypeBigQuery = "bigquery" OperationTypeHTTP = "http" OperationTypeFTP = "ftp" OperationTypeGit = "git" OperationTypeMongoDB = "mongodb" OperationTypeHubSpot = "hubspot" OperationTypeS3 = "s3" OperationTypeSnowflake = "snowflake" )
Variables ¶
This section is empty.
Functions ¶
func SinkBackendForOperationType ¶
func SinkBackendForOperationType(operationType string) (model.SinkBackend, bool)
func SinkReplayStrategyStrings ¶
func SinkReplayStrategyStrings() []string
SinkReplayStrategyStrings returns a slice of all String values of the enum
func SupportsIncrementalSourceCheckpointKind ¶
func SupportsIncrementalSourceCheckpointKind( operationType string, kind model.IncrementalCheckpointKind, ) bool
func SupportsSinkReplayStrategy ¶
func SupportsSinkReplayStrategy(dsType model.DataSourceType, strategy SinkReplayStrategy) bool
SupportsSinkReplayStrategy reports whether a sink connector permits the declared replay mechanism. Unknown and source-only connectors are rejected so callers cannot dispatch a side effect with an unverified contract.
Types ¶
type Descriptor ¶
type Descriptor struct {
Type model.DataSourceType
SchemaFamily SchemaFamily
QueryOperationType string
SinkBackend model.SinkBackend
SupportsPipelineSource bool
SupportsPipelineSink bool
SupportedSinkReplayStrategies []SinkReplayStrategy
SinkPayloadBinding SinkPayloadBinding
SinkResult SinkResultCapability
IncrementalSourceCheckpointKinds []model.IncrementalCheckpointKind
ForcedReadOnly bool
}
func AllDescriptors ¶
func AllDescriptors() []Descriptor
func DescriptorFor ¶
func DescriptorFor(dsType model.DataSourceType) (Descriptor, bool)
type SchemaFamily ¶
type SchemaFamily string
const ( SchemaFamilyUnknown SchemaFamily = "unknown" SchemaFamilySQL SchemaFamily = "sql" SchemaFamilyHTTP SchemaFamily = "http" SchemaFamilyDocument SchemaFamily = "document" SchemaFamilyFile SchemaFamily = "file" SchemaFamilyObjectAPI SchemaFamily = "object_api" SchemaFamilyObjectStore SchemaFamily = "object_store" )
type SinkPayloadBinding ¶
type SinkPayloadBinding string
const ( SinkPayloadBindingEncoded SinkPayloadBinding = "encoded" SinkPayloadBindingRowObject SinkPayloadBinding = "row_object" )
func SinkPayloadBindingForOperationType ¶
func SinkPayloadBindingForOperationType(operationType string) SinkPayloadBinding
SinkPayloadBindingForOperationType returns the public input shape expected by a sink connector. Connectors default to the encoded binding unless their catalog descriptor explicitly declares row-object input.
type SinkReplayStrategy ¶
type SinkReplayStrategy int
SinkReplayStrategy is the connector-level replay mechanism a sink operation may declare. Individual saved operations still select one strategy in the pipeline spec; this catalog list prevents UI and documentation from implying provider support that the adapter does not have.
const ( SinkReplayStrategyUnknown SinkReplayStrategy = iota // unknown SinkReplayStrategyNaturallyIdempotent // naturally_idempotent SinkReplayStrategyIdempotentWithKey // idempotent_with_key SinkReplayStrategyDeduplicatedByLedger // deduplicated_by_ledger SinkReplayStrategyUnsafe // unsafe )
func SinkReplayStrategyString ¶
func SinkReplayStrategyString(s string) (SinkReplayStrategy, error)
SinkReplayStrategyString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.
func SinkReplayStrategyValues ¶
func SinkReplayStrategyValues() []SinkReplayStrategy
SinkReplayStrategyValues returns all values of the enum
func (SinkReplayStrategy) IsASinkReplayStrategy ¶
func (i SinkReplayStrategy) IsASinkReplayStrategy() bool
IsASinkReplayStrategy returns "true" if the value is listed in the enum definition. "false" otherwise
func (SinkReplayStrategy) MarshalJSON ¶
func (i SinkReplayStrategy) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaler interface for SinkReplayStrategy
func (SinkReplayStrategy) MarshalText ¶
func (i SinkReplayStrategy) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface for SinkReplayStrategy
func (SinkReplayStrategy) String ¶
func (i SinkReplayStrategy) String() string
func (*SinkReplayStrategy) UnmarshalJSON ¶
func (i *SinkReplayStrategy) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaler interface for SinkReplayStrategy
func (*SinkReplayStrategy) UnmarshalText ¶
func (i *SinkReplayStrategy) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface for SinkReplayStrategy
type SinkResultCapability ¶
type SinkResultCapability struct {
Kind SinkResultKind
Operation string
}
func SinkResultForOperationType ¶
func SinkResultForOperationType(operationType string) SinkResultCapability
SinkResultForOperationType returns the result contract expected after sink dispatch. HTTP is the default for connectors without an explicit result shape.
type SinkResultKind ¶
type SinkResultKind string
const ( SinkResultKindHTTP SinkResultKind = "http" SinkResultKindObjectRows SinkResultKind = "object_rows" )
Source Files