Classes Reference

Plugin Classes

Tap

Abstract base class for taps.

Target

Abstract base class for targets.

SQLTap

A specialized Tap for extracting from SQL streams.

SQLTarget

Target implementation for SQL destinations.

InlineMapper

Abstract base class for inline mappers.

Stream Classes

Stream

Abstract base class for tap streams.

RESTStream

Abstract base class for REST API streams.

GraphQLStream

Abstract base class for API-type streams.

SQLStream

Base class for SQLAlchemy-based streams.

Sink Classes

Sink

Abstract base class for target sinks.

RecordSink

Base class for singleton record writers.

BatchSink

Base class for batched record writers.

SQLSink

SQL-type sink type.

SQL Connector for SQL Taps and Targets

SQLConnector

Base class for SQLAlchemy-based connectors.

Authenticator Classes

authenticators.APIAuthenticatorBase

Base class for offloading API auth.

authenticators.APIKeyAuthenticator

Implements API key authentication for REST Streams.

authenticators.BasicAuthenticator

Implements basic authentication for REST Streams.

authenticators.BearerTokenAuthenticator

Implements bearer token authentication for REST Streams.

authenticators.OAuthAuthenticator

API Authenticator for OAuth 2.0 flows.

authenticators.OAuthJWTAuthenticator

API Authenticator for OAuth 2.0 flows which utilize a JWT refresh token.

authenticators.SimpleAuthenticator

DEPRECATED: Please use a more specific authenticator.

Exception Types

exceptions.ConfigValidationError

Raised when a user's config settings fail validation.

exceptions.FatalAPIError

Exception raised when a failed request should not be considered retriable.

exceptions.InvalidStreamSortException

Exception to raise if sorting errors are found while syncing the records.

exceptions.MapExpressionError

Failed map expression evaluation.

exceptions.MaxRecordsLimitException

Exception indicating the sync aborted due to too many records.

exceptions.RecordsWithoutSchemaException

Raised if a target receives RECORD messages prior to a SCHEMA message.

exceptions.RetriableAPIError

Exception raised when a failed request can be safely retried.

exceptions.StreamMapConfigError

Raised when a stream map has an invalid configuration.

exceptions.TapStreamConnectionFailure

Exception to raise when stream connection fails or stream is disconnected.

exceptions.TooManyRecordsException

Exception to raise when query returns more records than max_records.

JSON Schema builder classes

typing.PropertiesList

Properties list.

typing.ArrayType

Array type.

typing.BooleanType

Boolean type.

typing.Constant

A constant property.

typing.CustomType

Accepts an arbitrary JSON Schema dictionary.

typing.DateTimeType

DateTime type.

typing.DateType

Date type.

typing.DiscriminatedUnion

A discriminator property.

typing.DurationType

Duration type.

typing.EmailType

Email type.

typing.HostnameType

Hostname type.

typing.IntegerType

Integer type.

typing.IPv4Type

IPv4 address type.

typing.IPv6Type

IPv6 type.

typing.JSONPointerType

JSONPointer type.

typing.NumberType

Number type.

typing.ObjectType

Object type, which wraps one or more named properties.

typing.OneOf

OneOf type.

typing.Property

Generic Property.

typing.RegexType

Regex type.

typing.RelativeJSONPointerType

RelativeJSONPointer type.

typing.StringType

String type.

typing.TimeType

Time type.

typing.URITemplateType

URITemplate type.

typing.URIType

URI type.

typing.UUIDType

UUID type.

Pagination

pagination.BaseAPIPaginator

An API paginator object.

pagination.SinglePagePaginator

A paginator that works with single-page endpoints.

pagination.BaseHATEOASPaginator

Paginator class for APIs supporting HATEOAS links in their response bodies.

pagination.HeaderLinkPaginator

Paginator class for APIs supporting HATEOAS links in their headers.

pagination.JSONPathPaginator

Paginator class for APIs returning a pagination token in the response body.

pagination.SimpleHeaderPaginator

Paginator class for APIs returning a pagination token in the response headers.

pagination.BasePageNumberPaginator

Paginator class for APIs that use page number.

pagination.BaseOffsetPaginator

Paginator class for APIs that use page offset.

pagination.LegacyPaginatedStreamProtocol

Protocol for legacy paginated streams classes.

pagination.LegacyStreamPaginator

Paginator that works with REST streams as they exist today.

Batch

batch.BaseBatcher

Base Record Batcher.

batch.JSONLinesBatcher

JSON Lines Record Batcher.

Other

connectors.sql.SQLToJSONSchema

SQLAlchemy to JSON Schema type mapping helper.

connectors.sql.JSONSchemaToSQL

A configurable mapper for converting JSON Schema types to SQLAlchemy types.