Contents Menu Expand Light mode Dark mode Auto light/dark mode
Meltano Singer SDK 0.28.0 documentation
Logo

Developer Resources

  • Getting Started
  • In-depth Guides
    • Singer Tap Porting Guide
    • Migrate your REST tap to use the new pagination classes!
    • Custom CLIs
  • Python Tips
  • Code Samples
  • Command Line Samples
  • Frequently Asked Questions

Reference

  • Classes Reference
    • singer_sdk.Tap
    • singer_sdk.Target
    • singer_sdk.SQLTap
    • singer_sdk.SQLTarget
    • singer_sdk.InlineMapper
    • singer_sdk.Stream
    • singer_sdk.RESTStream
    • singer_sdk.GraphQLStream
    • singer_sdk.SQLStream
    • singer_sdk.Sink
    • singer_sdk.RecordSink
    • singer_sdk.BatchSink
    • singer_sdk.SQLSink
    • singer_sdk.SQLConnector
    • singer_sdk.authenticators.APIAuthenticatorBase
    • singer_sdk.authenticators.APIKeyAuthenticator
    • singer_sdk.authenticators.BasicAuthenticator
    • singer_sdk.authenticators.BearerTokenAuthenticator
    • singer_sdk.authenticators.OAuthAuthenticator
    • singer_sdk.authenticators.OAuthJWTAuthenticator
    • singer_sdk.authenticators.SimpleAuthenticator
    • singer_sdk.exceptions.ConfigValidationError
    • singer_sdk.exceptions.FatalAPIError
    • singer_sdk.exceptions.InvalidStreamSortException
    • singer_sdk.exceptions.MapExpressionError
    • singer_sdk.exceptions.MaxRecordsLimitException
    • singer_sdk.exceptions.RecordsWithoutSchemaException
    • singer_sdk.exceptions.RetriableAPIError
    • singer_sdk.exceptions.StreamMapConfigError
    • singer_sdk.exceptions.TapStreamConnectionFailure
    • singer_sdk.exceptions.TooManyRecordsException
    • singer_sdk.typing.PropertiesList
    • singer_sdk.typing.ArrayType
    • singer_sdk.typing.BooleanType
    • singer_sdk.typing.CustomType
    • singer_sdk.typing.DateTimeType
    • singer_sdk.typing.DateType
    • singer_sdk.typing.DurationType
    • singer_sdk.typing.EmailType
    • singer_sdk.typing.HostnameType
    • singer_sdk.typing.IntegerType
    • singer_sdk.typing.IPv4Type
    • singer_sdk.typing.IPv6Type
    • singer_sdk.typing.JSONPointerType
    • singer_sdk.typing.NumberType
    • singer_sdk.typing.ObjectType
    • singer_sdk.typing.Property
    • singer_sdk.typing.RegexType
    • singer_sdk.typing.RelativeJSONPointerType
    • singer_sdk.typing.StringType
    • singer_sdk.typing.TimeType
    • singer_sdk.typing.URITemplateType
    • singer_sdk.typing.URIType
    • singer_sdk.typing.UUIDType
    • singer_sdk.pagination.BaseAPIPaginator
    • singer_sdk.pagination.SinglePagePaginator
    • singer_sdk.pagination.BaseHATEOASPaginator
    • singer_sdk.pagination.HeaderLinkPaginator
    • singer_sdk.pagination.JSONPathPaginator
    • singer_sdk.pagination.SimpleHeaderPaginator
    • singer_sdk.pagination.BasePageNumberPaginator
    • singer_sdk.pagination.BaseOffsetPaginator
    • singer_sdk.pagination.LegacyPaginatedStreamProtocol
    • singer_sdk.pagination.LegacyStreamPaginator
    • singer_sdk.batch.BaseBatcher
    • singer_sdk.batch.JSONLinesBatcher
  • Singer Implementation Details
    • Command Line Reference
    • Catalog Discovery
    • Catalog Metadata
    • Record Metadata
    • Tap Metrics
    • Logging
    • Stream State
    • “At Least Once” Delivery Promise
  • JSON Schema Helpers
  • Plugin Capabilities

Advanced Concepts

  • Incremental Replication
  • Parent-Child Streams
  • Stream Partitioning
  • The Context Object
  • Inline Stream Maps
  • Batch Messages
  • How to design a Sink
  • Testing Taps & Targets

SDK Development

  • Contributing Guide
  • Release Process
  • Deprecation Timeline
  v: latest
Versions
latest
stable
v0.28.0
v0.27.0
v0.26.0
v0.25.0
v0.24.0
v0.23.0
v0.22.1
v0.22.0
v0.21.0
v0.20.0
v0.19.0
v0.18.0
v0.17.0
v0.16.0
v0.15.0
v0.14.0
v0.13.1
v0.13.0
v0.12.0
v0.11.1
v0.11.0
v0.10.0
revamp-docs
match-sdk-site-to-brand-guidelines
main
Downloads
On Read the Docs
Project Home
Builds
Back to top
Copyright © 2021, Meltano Core Team and Contributors
Made with Sphinx and @pradyunsg's Furo