v0.18.0
SDK Dev Guide
Python Tips for SDK Developers
SDK Code Samples
Command Line Samples
Plugin Capabilities
Frequently Asked Questions
SDK Reference
Parent-Child Streams
Stream Partitioning
The Context Object
Inline Stream Maps
Batch Messages
Singer Tap Porting Guide
How to design a Sink
Contributing to the SDK
SDK Implementation Details
JSON Schema builder
Meltano Singer SDK
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
_
__init__() (singer_sdk.authenticators.APIAuthenticatorBase method)
(singer_sdk.authenticators.APIKeyAuthenticator method)
(singer_sdk.authenticators.BasicAuthenticator method)
(singer_sdk.authenticators.BearerTokenAuthenticator method)
(singer_sdk.authenticators.OAuthAuthenticator method)
(singer_sdk.authenticators.SimpleAuthenticator method)
(singer_sdk.exceptions.RetriableAPIError method)
(singer_sdk.InlineMapper method)
(singer_sdk.pagination.BaseAPIPaginator method)
(singer_sdk.pagination.BaseHATEOASPaginator method)
(singer_sdk.pagination.BaseOffsetPaginator method)
(singer_sdk.pagination.JSONPathPaginator method)
(singer_sdk.pagination.LegacyPaginatedStreamProtocol method)
(singer_sdk.pagination.LegacyStreamPaginator method)
(singer_sdk.pagination.SimpleHeaderPaginator method)
(singer_sdk.pagination.SinglePagePaginator method)
(singer_sdk.RESTStream method)
(singer_sdk.Sink method)
(singer_sdk.SQLConnector method)
(singer_sdk.SQLSink method)
(singer_sdk.SQLStream method)
(singer_sdk.SQLTap method)
(singer_sdk.SQLTarget method)
(singer_sdk.Stream method)
(singer_sdk.Tap method)
(singer_sdk.Target method)
(singer_sdk.typing.ArrayType method)
(singer_sdk.typing.CustomType method)
(singer_sdk.typing.ObjectType method)
(singer_sdk.typing.Property method)
A
ABOUT (singer_sdk.helpers.capabilities.PluginCapabilities attribute)
ACTIVATE_VERSION (singer_sdk.helpers.capabilities.PluginCapabilities attribute)
activate_version() (singer_sdk.Sink method)
(singer_sdk.SQLSink method)
add_sink() (singer_sdk.SQLTarget method)
(singer_sdk.Target method)
advance() (singer_sdk.pagination.BaseAPIPaginator method)
APIAuthenticatorBase (class in singer_sdk.authenticators)
APIKeyAuthenticator (class in singer_sdk.authenticators)
append() (singer_sdk.typing.PropertiesList method)
append_builtin_config() (singer_sdk.InlineMapper class method)
(singer_sdk.SQLTap class method)
(singer_sdk.SQLTarget class method)
(singer_sdk.Tap class method)
(singer_sdk.Target class method)
apply_catalog() (singer_sdk.Stream method)
ArrayType (class in singer_sdk.typing)
auth_endpoint (singer_sdk.authenticators.OAuthAuthenticator property)
auth_headers (singer_sdk.authenticators.APIAuthenticatorBase property)
(singer_sdk.authenticators.OAuthAuthenticator property)
auth_params (singer_sdk.authenticators.APIAuthenticatorBase property)
authenticate_request() (singer_sdk.authenticators.APIAuthenticatorBase method)
authenticator (singer_sdk.RESTStream property)
B
backoff_handler() (singer_sdk.RESTStream method)
backoff_max_tries() (singer_sdk.RESTStream method)
backoff_runtime() (singer_sdk.RESTStream method)
backoff_wait_generator() (singer_sdk.RESTStream method)
BaseAPIPaginator (class in singer_sdk.pagination)
BaseHATEOASPaginator (class in singer_sdk.pagination)
BaseOffsetPaginator (class in singer_sdk.pagination)
BasePageNumberPaginator (class in singer_sdk.pagination)
BasicAuthenticator (class in singer_sdk.authenticators)
BATCH (singer_sdk.helpers.capabilities.PluginCapabilities attribute)
batch_config (singer_sdk.Sink property)
batch_size (singer_sdk.Stream attribute)
BatchSink (class in singer_sdk)
BearerTokenAuthenticator (class in singer_sdk.authenticators)
BooleanType (class in singer_sdk.typing)
build_prepared_request() (singer_sdk.RESTStream method)
bulk_insert_records() (singer_sdk.SQLSink method)
C
calculate_sync_cost() (singer_sdk.RESTStream method)
CATALOG (singer_sdk.helpers.capabilities.TapCapabilities attribute)
catalog (singer_sdk.SQLTap property)
(singer_sdk.Tap property)
catalog_dict (singer_sdk.SQLTap property)
(singer_sdk.Tap property)
catalog_json_text (singer_sdk.SQLTap property)
(singer_sdk.Tap property)
check_sorted (singer_sdk.Stream property)
clean_up() (singer_sdk.Sink method)
cli (singer_sdk.InlineMapper attribute)
(singer_sdk.SQLTap attribute)
(singer_sdk.SQLTarget attribute)
(singer_sdk.Tap attribute)
(singer_sdk.Target attribute)
client_id (singer_sdk.authenticators.OAuthAuthenticator property)
client_secret (singer_sdk.authenticators.OAuthAuthenticator property)
column_exists() (singer_sdk.SQLConnector method)
compare_start_date() (singer_sdk.Stream method)
config (singer_sdk.authenticators.APIAuthenticatorBase property)
(singer_sdk.InlineMapper property)
(singer_sdk.Sink property)
(singer_sdk.SQLConnector property)
(singer_sdk.SQLTap property)
(singer_sdk.SQLTarget property)
(singer_sdk.Stream property)
(singer_sdk.Tap property)
(singer_sdk.Target property)
ConfigValidationError (class in singer_sdk.exceptions)
conform_name() (singer_sdk.SQLSink method)
conform_record() (singer_sdk.SQLSink method)
conform_schema() (singer_sdk.SQLSink method)
connection (singer_sdk.SQLConnector property)
(singer_sdk.SQLSink property)
connector (singer_sdk.SQLSink property)
(singer_sdk.SQLStream property)
connector_class (singer_sdk.SQLStream attribute)
count (singer_sdk.pagination.BaseAPIPaginator property)
create_empty_table() (singer_sdk.SQLConnector method)
create_for_stream() (singer_sdk.authenticators.APIKeyAuthenticator class method)
(singer_sdk.authenticators.BasicAuthenticator class method)
(singer_sdk.authenticators.BearerTokenAuthenticator class method)
create_schema() (singer_sdk.SQLConnector method)
create_sqlalchemy_connection() (singer_sdk.SQLConnector method)
create_sqlalchemy_engine() (singer_sdk.SQLConnector method)
current_size (singer_sdk.Sink property)
current_value (singer_sdk.pagination.BaseAPIPaginator property)
CustomType (class in singer_sdk.typing)
D
database_name (singer_sdk.SQLSink property)
DATATYPE_FAILSAFE (singer_sdk.helpers.capabilities.TargetCapabilities attribute)
datetime_error_treatment (singer_sdk.Sink property)
DateTimeType (class in singer_sdk.typing)
DateType (class in singer_sdk.typing)
descendent_streams (singer_sdk.Stream property)
DISCOVER (singer_sdk.helpers.capabilities.TapCapabilities attribute)
discover_catalog_entries() (singer_sdk.SQLConnector method)
discover_catalog_entry() (singer_sdk.SQLConnector method)
discover_streams() (singer_sdk.SQLTap method)
(singer_sdk.Tap method)
drain_all() (singer_sdk.SQLTarget method)
(singer_sdk.Target method)
drain_one() (singer_sdk.SQLTarget method)
(singer_sdk.Target method)
DurationType (class in singer_sdk.typing)
E
EmailType (class in singer_sdk.typing)
extend_validator_with_defaults() (in module singer_sdk.typing)
extra_retry_statuses (singer_sdk.RESTStream attribute)
F
FatalAPIError (class in singer_sdk.exceptions)
finalize_state_progress_markers() (singer_sdk.Stream method)
finished (singer_sdk.pagination.BaseAPIPaginator property)
full_schema_name (singer_sdk.SQLSink property)
full_table_name (singer_sdk.SQLSink property)
fully_qualified_name (singer_sdk.SQLStream property)
G
generate_insert_statement() (singer_sdk.SQLSink method)
get_batch_config() (singer_sdk.Stream method)
get_batches() (singer_sdk.Stream method)
get_child_context() (singer_sdk.Stream method)
get_column_add_ddl() (singer_sdk.SQLConnector static method)
get_column_alter_ddl() (singer_sdk.SQLConnector static method)
get_column_rename_ddl() (singer_sdk.SQLConnector static method)
get_context_state() (singer_sdk.Stream method)
get_fully_qualified_name() (singer_sdk.SQLConnector static method)
get_new_paginator() (singer_sdk.RESTStream method)
get_next() (singer_sdk.pagination.BaseAPIPaginator method)
(singer_sdk.pagination.BaseHATEOASPaginator method)
(singer_sdk.pagination.BaseOffsetPaginator method)
(singer_sdk.pagination.BasePageNumberPaginator method)
(singer_sdk.pagination.JSONPathPaginator method)
(singer_sdk.pagination.LegacyStreamPaginator method)
(singer_sdk.pagination.SimpleHeaderPaginator method)
(singer_sdk.pagination.SinglePagePaginator method)
get_next_page_token() (singer_sdk.pagination.LegacyPaginatedStreamProtocol method)
get_next_url() (singer_sdk.pagination.BaseHATEOASPaginator method)
(singer_sdk.pagination.HeaderLinkPaginator method)
get_object_names() (singer_sdk.SQLConnector method)
get_records() (singer_sdk.RESTStream method)
(singer_sdk.SQLStream method)
(singer_sdk.Stream method)
get_replication_key_signpost() (singer_sdk.Stream method)
get_schema_names() (singer_sdk.SQLConnector method)
get_selected_schema() (singer_sdk.SQLStream method)
get_sink() (singer_sdk.SQLTarget method)
(singer_sdk.Target method)
get_sink_class() (singer_sdk.SQLTarget method)
(singer_sdk.Target method)
get_sqlalchemy_url() (singer_sdk.SQLConnector method)
get_starting_replication_key_value() (singer_sdk.Stream method)
get_starting_timestamp() (singer_sdk.Stream method)
get_table() (singer_sdk.SQLConnector method)
get_table_columns() (singer_sdk.SQLConnector method)
get_url() (singer_sdk.RESTStream method)
get_url_params() (singer_sdk.RESTStream method)
GraphQLStream (class in singer_sdk)
H
HARD_DELETE (singer_sdk.helpers.capabilities.TargetCapabilities attribute)
has_more() (singer_sdk.pagination.BaseAPIPaginator method)
(singer_sdk.pagination.BaseOffsetPaginator method)
(singer_sdk.pagination.BasePageNumberPaginator method)
has_selected_descendents (singer_sdk.Stream property)
HeaderLinkPaginator (class in singer_sdk.pagination)
HostnameType (class in singer_sdk.typing)
http_headers (singer_sdk.RESTStream property)
I
include_sdc_metadata_properties (singer_sdk.Sink property)
InlineMapper (class in singer_sdk)
input_catalog (singer_sdk.SQLTap property)
(singer_sdk.Tap property)
IntegerType (class in singer_sdk.typing)
InvalidStreamSortException (class in singer_sdk.exceptions)
IPv4Type (class in singer_sdk.typing)
IPv6Type (class in singer_sdk.typing)
is_full (singer_sdk.Sink property)
is_sorted (singer_sdk.Stream property)
is_timestamp_replication_key (singer_sdk.Stream property)
is_token_valid() (singer_sdk.authenticators.OAuthAuthenticator method)
items() (singer_sdk.typing.PropertiesList method)
J
JSONPathPaginator (class in singer_sdk.pagination)
JSONPointerType (class in singer_sdk.typing)
JSONTypeHelper (class in singer_sdk.typing)
K
key_properties (singer_sdk.Sink property)
(singer_sdk.SQLSink property)
L
LegacyPaginatedStreamProtocol (class in singer_sdk.pagination)
LegacyStreamPaginator (class in singer_sdk.pagination)
listen() (singer_sdk.InlineMapper method)
(singer_sdk.SQLTarget method)
(singer_sdk.Target method)
load_state() (singer_sdk.SQLTap method)
(singer_sdk.Tap method)
load_streams() (singer_sdk.SQLTap method)
(singer_sdk.Tap method)
LOG_BASED (singer_sdk.helpers.capabilities.TapCapabilities attribute)
log_sync_costs() (singer_sdk.Stream method)
logger (singer_sdk.SQLConnector property)
M
map_activate_version_message() (singer_sdk.InlineMapper method)
map_batch_message() (singer_sdk.InlineMapper method)
map_record_message() (singer_sdk.InlineMapper method)
map_schema_message() (singer_sdk.InlineMapper method)
map_state_message() (singer_sdk.InlineMapper method)
MapExpressionError (class in singer_sdk.exceptions)
mark_drained() (singer_sdk.Sink method)
mask (singer_sdk.Stream property)
max_parallelism (singer_sdk.SQLTarget property)
(singer_sdk.Target property)
max_size (singer_sdk.Sink property)
MaxRecordsLimitException (class in singer_sdk.exceptions)
merge_sql_types() (singer_sdk.SQLConnector method)
merge_upsert_from_table() (singer_sdk.SQLSink method)
metadata (singer_sdk.SQLStream property)
(singer_sdk.Stream property)
module
singer_sdk.typing
N
next_page_token_jsonpath (singer_sdk.RESTStream attribute)
NumberType (class in singer_sdk.typing)
O
oauth_request_body (singer_sdk.authenticators.OAuthAuthenticator property)
(singer_sdk.authenticators.OAuthJWTAuthenticator property)
oauth_request_payload (singer_sdk.authenticators.OAuthAuthenticator property)
(singer_sdk.authenticators.OAuthJWTAuthenticator property)
oauth_scopes (singer_sdk.authenticators.OAuthAuthenticator property)
OAuthAuthenticator (class in singer_sdk.authenticators)
OAuthJWTAuthenticator (class in singer_sdk.authenticators)
ObjectType (class in singer_sdk.typing)
P
parent_stream_type (singer_sdk.Stream attribute)
parse_full_table_name() (singer_sdk.SQLConnector method)
parse_response() (singer_sdk.RESTStream method)
partitions (singer_sdk.Stream property)
post_process() (singer_sdk.Stream method)
prepare_column() (singer_sdk.SQLConnector method)
prepare_request() (singer_sdk.RESTStream method)
prepare_request_payload() (singer_sdk.GraphQLStream method)
(singer_sdk.RESTStream method)
prepare_schema() (singer_sdk.SQLConnector method)
prepare_table() (singer_sdk.SQLConnector method)
preprocess_record() (singer_sdk.Sink method)
primary_keys (singer_sdk.SQLStream property)
(singer_sdk.Stream property)
print_about() (singer_sdk.InlineMapper class method)
(singer_sdk.SQLTap class method)
(singer_sdk.SQLTarget class method)
(singer_sdk.Tap class method)
(singer_sdk.Target class method)
print_version() (singer_sdk.InlineMapper class method)
(singer_sdk.SQLTap class method)
(singer_sdk.SQLTarget class method)
(singer_sdk.Tap class method)
(singer_sdk.Target class method)
private_key (singer_sdk.authenticators.OAuthJWTAuthenticator property)
private_key_passphrase (singer_sdk.authenticators.OAuthJWTAuthenticator property)
process_batch() (singer_sdk.BatchSink method)
(singer_sdk.RecordSink method)
(singer_sdk.Sink method)
(singer_sdk.SQLSink method)
process_batch_files() (singer_sdk.Sink method)
process_record() (singer_sdk.BatchSink method)
(singer_sdk.RecordSink method)
(singer_sdk.Sink method)
PROPERTIES (singer_sdk.helpers.capabilities.TapCapabilities attribute)
PropertiesList (class in singer_sdk.typing)
Property (class in singer_sdk.typing)
Q
query (singer_sdk.GraphQLStream property)
quote() (singer_sdk.SQLConnector method)
R
RECORD_FLATTENING (singer_sdk.helpers.capabilities.TargetCapabilities attribute)
records_jsonpath (singer_sdk.GraphQLStream property)
(singer_sdk.RESTStream attribute)
RecordSink (class in singer_sdk)
RecordsWithoutSchemaException (class in singer_sdk.exceptions)
RegexType (class in singer_sdk.typing)
RelativeJSONPointerType (class in singer_sdk.typing)
rename_column() (singer_sdk.SQLConnector method)
replication_key (singer_sdk.Stream property)
replication_method (singer_sdk.Stream property)
request_decorator() (singer_sdk.RESTStream method)
request_records() (singer_sdk.RESTStream method)
requests_session (singer_sdk.RESTStream property)
reset_state_progress_markers() (singer_sdk.Stream method)
response_error_message() (singer_sdk.RESTStream method)
RESTStream (class in singer_sdk)
RetriableAPIError (class in singer_sdk.exceptions)
run_connection_test() (singer_sdk.SQLTap method)
(singer_sdk.Tap method)
run_discovery() (singer_sdk.SQLTap method)
(singer_sdk.Tap method)
S
schema (singer_sdk.SQLStream property)
(singer_sdk.Stream property)
schema_exists() (singer_sdk.SQLConnector method)
schema_filepath (singer_sdk.Stream property)
schema_name (singer_sdk.SQLSink property)
selected (singer_sdk.Stream property)
setup() (singer_sdk.Sink method)
(singer_sdk.SQLSink method)
SimpleAuthenticator (class in singer_sdk.authenticators)
SimpleHeaderPaginator (class in singer_sdk.pagination)
singer_sdk.typing
module
SinglePagePaginator (class in singer_sdk.pagination)
Sink (class in singer_sdk)
sink_exists() (singer_sdk.SQLTarget method)
(singer_sdk.Target method)
SOFT_DELETE (singer_sdk.helpers.capabilities.TargetCapabilities attribute)
sqlalchemy_url (singer_sdk.SQLConnector property)
SQLConnector (class in singer_sdk)
SQLSink (class in singer_sdk)
SQLStream (class in singer_sdk)
SQLTap (class in singer_sdk)
SQLTarget (class in singer_sdk)
start_batch() (singer_sdk.BatchSink method)
(singer_sdk.RecordSink method)
start_drain() (singer_sdk.Sink method)
STATE (singer_sdk.helpers.capabilities.TapCapabilities attribute)
state (singer_sdk.InlineMapper property)
(singer_sdk.SQLTap property)
(singer_sdk.SQLTarget property)
(singer_sdk.Tap property)
(singer_sdk.Target property)
STATE_MSG_FREQUENCY (singer_sdk.Stream attribute)
state_partitioning_keys (singer_sdk.Stream property)
Stream (class in singer_sdk)
STREAM_MAPS (singer_sdk.helpers.capabilities.PluginCapabilities attribute)
stream_maps (singer_sdk.Stream property)
stream_state (singer_sdk.Stream property)
StreamMapConfigError (class in singer_sdk.exceptions)
streams (singer_sdk.SQLTap property)
(singer_sdk.Tap property)
string_format (singer_sdk.typing.DateTimeType attribute)
(singer_sdk.typing.DateType attribute)
(singer_sdk.typing.DurationType attribute)
(singer_sdk.typing.EmailType attribute)
(singer_sdk.typing.HostnameType attribute)
(singer_sdk.typing.IPv4Type attribute)
(singer_sdk.typing.IPv6Type attribute)
(singer_sdk.typing.JSONPointerType attribute)
(singer_sdk.typing.RegexType attribute)
(singer_sdk.typing.RelativeJSONPointerType attribute)
(singer_sdk.typing.StringType attribute)
(singer_sdk.typing.TimeType attribute)
(singer_sdk.typing.URIReferenceType attribute)
(singer_sdk.typing.URITemplateType attribute)
(singer_sdk.typing.URIType attribute)
(singer_sdk.typing.UUIDType attribute)
StringType (class in singer_sdk.typing)
sync() (singer_sdk.Stream method)
sync_all() (singer_sdk.SQLTap method)
(singer_sdk.Tap method)
T
table_exists() (singer_sdk.SQLConnector method)
table_name (singer_sdk.SQLSink property)
tally_duplicate_merged() (singer_sdk.Sink method)
tally_record_read() (singer_sdk.Sink method)
tally_record_written() (singer_sdk.Sink method)
Tap (class in singer_sdk)
tap_state (singer_sdk.Stream property)
tap_stream_id (singer_sdk.SQLStream property)
(singer_sdk.Stream property)
TapStreamConnectionFailure (class in singer_sdk.exceptions)
Target (class in singer_sdk)
TARGET_SCHEMA (singer_sdk.helpers.capabilities.TargetCapabilities attribute)
TEST (singer_sdk.helpers.capabilities.TapCapabilities attribute)
timeout (singer_sdk.RESTStream property)
TimeType (class in singer_sdk.typing)
to_dict() (singer_sdk.typing.JSONTypeHelper method)
(singer_sdk.typing.Property method)
to_json() (singer_sdk.typing.JSONTypeHelper method)
to_jsonschema_type() (in module singer_sdk.typing)
(singer_sdk.SQLConnector static method)
to_sql_type() (in module singer_sdk.typing)
(singer_sdk.SQLConnector static method)
TooManyRecordsException (class in singer_sdk.exceptions)
TYPE_CONFORMANCE_LEVEL (singer_sdk.Stream attribute)
type_dict (singer_sdk.typing.ArrayType property)
(singer_sdk.typing.CustomType property)
(singer_sdk.typing.JSONTypeHelper property)
(singer_sdk.typing.ObjectType property)
(singer_sdk.typing.Property property)
U
update_access_token() (singer_sdk.authenticators.OAuthAuthenticator method)
update_sync_costs() (singer_sdk.RESTStream method)
URIReferenceType (class in singer_sdk.typing)
URITemplateType (class in singer_sdk.typing)
URIType (class in singer_sdk.typing)
url_base (singer_sdk.RESTStream property)
UUIDType (class in singer_sdk.typing)
V
validate_response() (singer_sdk.RESTStream method)
W
write_schemas() (singer_sdk.SQLTap method)
(singer_sdk.Tap method)
Read the Docs
v: v0.18.0
Versions
latest
stable
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