Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Meltano Singer SDK 0.53.5 documentation
Logo

Developer Resources

  • Getting Started
  • In-depth Guides
    • Singer Tap Porting Guide
    • Migrate your REST tap to use the new pagination classes!
    • Schema Sources
    • Custom CLIs
    • Defining a configuration schema
    • Tap and target performance
    • Building SQL taps
    • Building SQL targets
    • Migrating a plugin from Poetry to uv
  • Python Tips
  • Code Samples
  • Command Line Samples
  • Frequently Asked Questions

Reference

  • Classes Reference
    • singer_sdk.Tap
    • singer_sdk.Target
    • singer_sdk.InlineMapper
    • singer_sdk.sql.SQLTap
    • singer_sdk.sql.SQLTarget
    • singer_sdk.Stream
    • singer_sdk.RESTStream
    • singer_sdk.GraphQLStream
    • singer_sdk.sql.SQLStream
    • singer_sdk.Sink
    • singer_sdk.RecordSink
    • singer_sdk.BatchSink
    • singer_sdk.sql.SQLSink
    • singer_sdk.sql.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.exceptions.DiscoveryError
    • singer_sdk.exceptions.InvalidReplicationKeyException
    • singer_sdk.exceptions.RequestedAbortException
    • singer_sdk.exceptions.AbortedSyncExceptionBase
    • singer_sdk.exceptions.AbortedSyncFailedException
    • singer_sdk.exceptions.AbortedSyncPausedException
    • singer_sdk.exceptions.ConformedNameClashException
    • singer_sdk.exceptions.MissingKeyPropertiesError
    • singer_sdk.exceptions.InvalidJSONSchema
    • singer_sdk.exceptions.InvalidRecord
    • singer_sdk.typing.PropertiesList
    • singer_sdk.typing.ArrayType
    • singer_sdk.typing.BooleanType
    • singer_sdk.typing.Constant
    • singer_sdk.typing.CustomType
    • singer_sdk.typing.DateTimeType
    • singer_sdk.typing.DateType
    • singer_sdk.typing.DecimalType
    • singer_sdk.typing.DiscriminatedUnion
    • 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.ObjectType
    • singer_sdk.typing.OneOf
    • 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.Batcher
    • singer_sdk.schema.source.SchemaSource
    • singer_sdk.schema.source.SchemaDirectory
    • singer_sdk.schema.source.StreamSchema
    • singer_sdk.schema.source.OpenAPISchema
    • singer_sdk.testing.runners.SingerTestRunner
    • singer_sdk.testing.runners.TapTestRunner
    • singer_sdk.testing.runners.TargetTestRunner
    • singer_sdk.testing.factory.get_tap_test_class
    • singer_sdk.testing.factory.get_target_test_class
    • singer_sdk.testing.config.SuiteConfig
    • singer_sdk.testing.tap_tests.TapCLIPrintsTest
    • singer_sdk.testing.tap_tests.TapDiscoveryTest
    • singer_sdk.testing.tap_tests.TapStreamConnectionTest
    • singer_sdk.testing.tap_tests.TapValidFinalStateTest
    • singer_sdk.testing.tap_tests.StreamSchemaIsValidTest
    • singer_sdk.testing.tap_tests.StreamReturnsRecordTest
    • singer_sdk.testing.tap_tests.StreamCatalogSchemaMatchesRecordTest
    • singer_sdk.testing.tap_tests.StreamRecordMatchesStreamSchema
    • singer_sdk.testing.tap_tests.StreamRecordSchemaMatchesCatalogTest
    • singer_sdk.testing.tap_tests.StreamPrimaryKeysTest
    • singer_sdk.testing.tap_tests.AttributeIsBooleanTest
    • singer_sdk.testing.tap_tests.AttributeIsDateTimeTest
    • singer_sdk.testing.tap_tests.AttributeIsIntegerTest
    • singer_sdk.testing.tap_tests.AttributeIsNumberTest
    • singer_sdk.testing.tap_tests.AttributeIsObjectTest
    • singer_sdk.testing.tap_tests.AttributeNotNullTest
    • singer_sdk.testing.target_tests.TargetCliPrintsTest
    • singer_sdk.testing.target_tests.TargetArrayData
    • singer_sdk.testing.target_tests.TargetCamelcaseTest
    • singer_sdk.testing.target_tests.TargetCamelcaseComplexSchema
    • singer_sdk.testing.target_tests.TargetDuplicateRecords
    • singer_sdk.testing.target_tests.TargetEncodedStringData
    • singer_sdk.testing.target_tests.TargetInvalidSchemaTest
    • singer_sdk.testing.target_tests.TargetMultipleStateMessages
    • singer_sdk.testing.target_tests.TargetNoPrimaryKeys
    • singer_sdk.testing.target_tests.TargetOptionalAttributes
    • singer_sdk.testing.target_tests.TargetPrimaryKeyUpdates
    • singer_sdk.testing.target_tests.TargetRecordBeforeSchemaTest
    • singer_sdk.testing.target_tests.TargetRecordMissingKeyProperty
    • singer_sdk.testing.target_tests.TargetRecordMissingOptionalFields
    • singer_sdk.testing.target_tests.TargetSchemaNoProperties
    • singer_sdk.testing.target_tests.TargetSchemaUpdates
    • singer_sdk.testing.target_tests.TargetSpecialCharsInAttributes
    • singer_sdk.testing.templates.TestTemplate
    • singer_sdk.testing.templates.TapTestTemplate
    • singer_sdk.testing.templates.TargetTestTemplate
    • singer_sdk.testing.templates.StreamTestTemplate
    • singer_sdk.testing.templates.AttributeTestTemplate
    • singer_sdk.testing.suites.SingerTestSuite
    • singer_sdk.singerlib.messages.Message
    • singer_sdk.singerlib.messages.RecordMessage
    • singer_sdk.singerlib.messages.SchemaMessage
    • singer_sdk.singerlib.messages.StateMessage
    • singer_sdk.singerlib.messages.ActivateVersionMessage
    • singer_sdk.singerlib.messages.SingerMessageType
    • singer_sdk.singerlib.catalog.Catalog
    • singer_sdk.singerlib.catalog.CatalogEntry
    • singer_sdk.singerlib.catalog.Metadata
    • singer_sdk.singerlib.catalog.MetadataMapping
    • singer_sdk.singerlib.catalog.StreamMetadata
    • singer_sdk.singerlib.catalog.SelectionMask
    • singer_sdk.singerlib.schema.Schema
    • singer_sdk.singerlib.schema.resolve_schema_references
    • singer_sdk.singerlib.messages.exclude_null_dict
    • singer_sdk.singerlib.messages.format_message
    • singer_sdk.singerlib.messages.write_message
    • singer_sdk.contrib.filesystem.stream.FileStream
    • singer_sdk.contrib.filesystem.tap.FolderTap
    • singer_sdk.contrib.batch_encoder_jsonl.JSONLinesBatcher
    • singer_sdk.contrib.batch_encoder_parquet.ParquetBatcher
    • singer_sdk.helpers.capabilities.CapabilitiesEnum
    • singer_sdk.helpers.capabilities.PluginCapabilities
    • singer_sdk.helpers.capabilities.TapCapabilities
    • singer_sdk.helpers.capabilities.TargetCapabilities
    • singer_sdk.helpers.capabilities.TargetLoadMethods
    • singer_sdk.helpers.jsonpath.extract_jsonpath
    • singer_sdk.about.AboutInfo
    • singer_sdk.about.AboutFormatter
    • singer_sdk.about.JSONFormatter
    • singer_sdk.about.MarkdownFormatter
    • singer_sdk.metrics.Point
    • singer_sdk.metrics.Metric
    • singer_sdk.metrics.Tag
    • singer_sdk.metrics.Status
    • singer_sdk.sql.connector.SQLToJSONSchema
    • singer_sdk.sql.connector.JSONSchemaToSQL
  • Singer Implementation Details
    • Command Line Reference
    • Catalog Discovery
    • Catalog Metadata
    • Record Metadata
    • Tap and Target 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
Back to top
View this page
Edit this page

singer_sdk.singerlib.messages.StateMessage¶

class singer_sdk.singerlib.messages.StateMessage[source]¶

Singer state message.

__init__(value)[source]¶
Parameters:

value (Mapping[str, Any])

Return type:

None

value: Mapping[str, Any][source]¶

The state value.

Next
singer_sdk.singerlib.messages.ActivateVersionMessage
Previous
singer_sdk.singerlib.messages.SchemaMessage
Copyright © 2026, Arch Data, Inc and Contributors
Made with Sphinx and @pradyunsg's Furo
On this page
  • singer_sdk.singerlib.messages.StateMessage
    • StateMessage
      • StateMessage.__init__()
      • StateMessage.value