refactor: Use a single source of truth for built-in capabilities

meltano · Jul 1, 2024 · 93bbe08 · 93bbe08
1 parent 4674b3f
commit 93bbe08
Show file tree

Hide file tree

Showing 19 changed files with 709 additions and 523 deletions.
diff --git a/docs/builtin.rst b/docs/builtin.rst
@@ -0,0 +1,17 @@
+Built-in Settings and Capabilities
+==================================
+
+.. currentmodule:: singer_sdk.helpers.capabilities
+
+The Singer SDK library provides a number of built-in settings and capabilities.
+
+.. autodata:: ADD_RECORD_METADATA
+   :no-value:
+
+   .. autoattribute:: ADD_RECORD_METADATA.schema
+
+.. autodata:: BATCH
+   :no-value:
+
+   .. autoattribute:: BATCH.schema
+   .. autoattribute:: BATCH.capability
diff --git a/docs/index.rst b/docs/index.rst
@@ -57,6 +57,7 @@ within the `#singer-tap-development`_ and `#singer-target-development`_ Slack ch
    implementation/index
    typing
    capabilities
+   builtin
 
 .. toctree::
    :caption: Advanced Concepts

diff --git a/singer_sdk/connectors/sql.py b/singer_sdk/connectors/sql.py
@@ -17,7 +17,7 @@
 from singer_sdk import typing as th
 from singer_sdk._singerlib import CatalogEntry, MetadataMapping, Schema
 from singer_sdk.exceptions import ConfigValidationError
-from singer_sdk.helpers.capabilities import TargetLoadMethods
+from singer_sdk.helpers import capabilities
 
 if t.TYPE_CHECKING:
     from sqlalchemy.engine import Engine
@@ -779,7 +779,7 @@ def prepare_table(
                 as_temp_table=as_temp_table,
             )
             return
-        if self.config["load_method"] == TargetLoadMethods.OVERWRITE:
+        if self.config["load_method"] == capabilities.TargetLoadMethods.OVERWRITE:
             self.get_table(full_table_name=full_table_name).drop(self._engine)
             self.create_empty_table(
                 full_table_name=full_table_name,