liminal-orm 3.1.1__tar.gz → 3.2.1__tar.gz

{liminal_orm-3.1.1 → liminal_orm-3.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: liminal-orm
-Version: 3.1.1
+Version: 3.2.1
 Summary: An ORM and toolkit that builds on top of Benchling's platform to keep your schemas and downstream code dependencies in sync.
 Home-page: https://github.com/dynotx/liminal-orm
 Author: DynoTx Open Source
@@ -11,8 +11,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: benchling-sdk (>=1.8.0)
+Requires-Dist: benchling-sdk (>=1.21.2,<2.0.0)
 Requires-Dist: bs4 (>=0.0.2,<0.0.3)
 Requires-Dist: lxml (>=5.3.0,<6.0.0)
 Requires-Dist: numpy (>=1.23.5,<2.0.0)

{liminal_orm-3.1.1 → liminal_orm-3.2.1}/liminal/base/name_template_parts.py

@@ -3,7 +3,6 @@ import warnings
 from liminal.orm.name_template_parts import *  # noqa: F403
 
 warnings.warn(
-    "Importing from 'liminal.base.name_template_parts' is deprecated. Please import from 'liminal.orm.name_template_parts' instead.",
-    DeprecationWarning,
-    stacklevel=2,
+    "Importing from 'liminal.base.name_template_parts' is deprecated. Please import from 'liminal.orm.name_template_parts' instead. This will be removed in v4.",
+    FutureWarning,
 )

{liminal_orm-3.1.1 → liminal_orm-3.2.1}/liminal/base/properties/base_field_properties.py

@@ -4,10 +4,7 @@ from typing import Any
 
 from pydantic import BaseModel, ConfigDict, PrivateAttr
 
-from liminal.base.base_dropdown import BaseDropdown
 from liminal.enums import BenchlingFieldType
-from liminal.orm.base_model import BaseModel as BenchlingBaseModel
-from liminal.utils import is_valid_wh_name
 
 
 class BaseFieldProperties(BaseModel):
@@ -71,25 +68,6 @@ class BaseFieldProperties(BaseModel):
         """If the Field Properties are meant to represent a column in Benchling,
         this will validate the properties and ensure that the entity_link and dropdowns are valid names that exist in our code.
         """
-        if self.entity_link:
-            if self.entity_link not in [
-                s.__schema_properties__.warehouse_name
-                for s in BenchlingBaseModel.get_all_subclasses()
-            ]:
-                raise ValueError(
-                    f"Field {wh_name}: could not find entity link {self.entity_link} as a warehouse name for any currently defined schemas."
-                )
-        if self.dropdown_link:
-            if self.dropdown_link not in [
-                d.__benchling_name__ for d in BaseDropdown.get_all_subclasses()
-            ]:
-                raise ValueError(
-                    f"Field {wh_name}: could not find dropdown link {self.dropdown_link} as a name to any defined dropdowns."
-                )
-        if not is_valid_wh_name(wh_name):
-            raise ValueError(
-                f"Field {wh_name}: invalid warehouse name '{wh_name}'. It should only contain alphanumeric characters and underscores."
-            )
         return True
 
     def merge(self, new_props: BaseFieldProperties) -> dict[str, Any]:

{liminal_orm-3.1.1 → liminal_orm-3.2.1}/liminal/base/properties/base_schema_properties.py

@@ -91,7 +91,7 @@ class BaseSchemaProperties(BaseModel):
 
     def __init__(self, **data: Any):
         super().__init__(**data)
-        self._archived = data.get("_archived", None)
+        self._archived = data.get("_archived", None)  # TODO: WHY??
 
     model_config = ConfigDict(arbitrary_types_allowed=True)
 

{liminal_orm-3.1.1 → liminal_orm-3.2.1}/liminal/cli/cli.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python
+import warnings
 from pathlib import Path
 
 import typer
@@ -17,7 +18,9 @@ from liminal.cli.live_test_entity_schema_migration import (
     mock_entity_schema_full_migration,
 )
 from liminal.cli.utils import read_local_liminal_dir, update_env_revision_id
-from liminal.connection.benchling_service import BenchlingService
+from liminal.connection.benchling_service import (
+    BenchlingService,
+)
 from liminal.migrate.revisions_timeline import RevisionsTimeline
 
 
@@ -54,15 +57,22 @@ def init() -> None:
     new_revision_file_path = RevisionsTimeline(VERSIONS_DIR_PATH).init_versions(
         VERSIONS_DIR_PATH
     )
-    revision_id = new_revision_file_path.name.split("_")[0]
-    env_file = f"""# This file is auto-generated by Liminal.
+
+    env_file = """# This file is auto-generated by Liminal.
 # Import the models and dropdowns you want to keep in sync here.
 # Instantiate the BenchlingConnection(s) with the correct parameters for your tenant(s).
-# There must be a revision_id variable defined for each BenchlingConnection instance. The variable name should match the `current_revision_id_var_name` variable passed into the BenchlingConnection instance.
-# The revision_id variable name can also match the format `<tenant_name>_CURRENT_REVISION_ID` / `<tenant_alias>_CURRENT_REVISION_ID`.
-from liminal.connection import BenchlingConnection
+from liminal.connection import BenchlingConnection, TenantConfigFlags
 
-CURRENT_REVISION_ID = "{revision_id}"
+connection = BenchlingConnection(
+    tenant_name="pizzahouse-prod",
+    tenant_alias="prod",
+    api_client_id="my-secret-api-client-id",
+    api_client_secret="my-secret-api-client-secret",
+    warehouse_connection_string="...",
+    internal_api_admin_email="my-secret-internal-api-admin-email",
+    internal_api_admin_password="my-secret-internal-api-admin-password",
+    config_flags=TenantConfigFlags(...)
+)
 """
     with open(ENV_FILE_PATH, "w") as file:
         file.write(env_file)
@@ -86,9 +96,7 @@ def generate_files(
         help="The path to write the generated files to.",
     ),
 ) -> None:
-    current_revision_id, benchling_connection = read_local_liminal_dir(
-        LIMINAL_DIR_PATH, benchling_tenant
-    )
+    _, benchling_connection = read_local_liminal_dir(LIMINAL_DIR_PATH, benchling_tenant)
     benchling_service = BenchlingService(benchling_connection, use_internal_api=True)
     if not write_path.exists():
         write_path.mkdir()
@@ -98,7 +106,7 @@ def generate_files(
 
 @app.command(
     name="current",
-    help="Returns the CURRENT_REVISION_ID that your Benchling tenant is on. Reads from liminal/env.py.",
+    help="Returns the remote revision_id that your Benchling tenant is currently on. Reads this from the name on the '_liminal_remote' schema.",
 )
 def current(
     benchling_tenant: str = typer.Argument(
@@ -108,16 +116,34 @@ def current(
     current_revision_id, benchling_connection = read_local_liminal_dir(
         LIMINAL_DIR_PATH, benchling_tenant
     )
-    print(
-        f"[blue]{benchling_connection.current_revision_id_var_name}: {current_revision_id}[/blue]"
-    )
+    benchling_service = BenchlingService(benchling_connection, use_internal_api=True)
+    try:
+        remote_revision_id = benchling_service.get_remote_revision_id()
+        if current_revision_id is not None:
+            warnings.warn(
+                f"Accessing and using the revision_id variable in {LIMINAL_DIR_PATH/'env.py'} is deprecated. Delete the variable set in the env.py file, the revision_id is now stored in your Benchling tenant within the '_liminal_remote' schema. Support for reading/writing the local revision_id will end with the v4 release.",
+                FutureWarning,
+            )
+        current_revision_id = remote_revision_id
+    except Exception:
+        pass
+    print(f"[blue]Current revision_id: {current_revision_id}.")
 
 
 @app.command(
-    name="autogenerate",
+    name="head",
+    help="Returns the local heads, or the latest revision_id, in your linear revision timeline.",
+)
+def head() -> None:
+    revision_timeline = RevisionsTimeline(VERSIONS_DIR_PATH)
+    print(f"[blue]{revision_timeline.get_latest_revision().id}: (head)[/blue]")
+
+
+@app.command(
+    name="revision",
     help="Generates a revision file with a list of operations to bring the given Benchling tenant up to date with the locally defined schemas. Writes revision file to liminal/versions/.",
 )
-def autogenerate(
+def revision(
     benchling_tenant: str = typer.Argument(
         ..., help="Benchling tenant (or alias) to connect to."
     ),
@@ -125,19 +151,56 @@ def autogenerate(
         ...,
         help="A description of the revision being generated. This will also be included in the file name.",
     ),
+    autogenerate: bool = typer.Option(
+        True,
+        "--autogenerate",
+        help="Automatically generate the revision file based on comparisons.",
+    ),
 ) -> None:
     current_revision_id, benchling_connection = read_local_liminal_dir(
         LIMINAL_DIR_PATH, benchling_tenant
     )
     benchling_service = BenchlingService(benchling_connection, use_internal_api=True)
+    try:
+        remote_revision_id = benchling_service.get_remote_revision_id()
+        if current_revision_id is not None:
+            warnings.warn(
+                f"Accessing and using the revision_id variable in {LIMINAL_DIR_PATH/'env.py'} is deprecated. Delete the variable set in the env.py file, the revision_id is now stored in your Benchling tenant within the '_liminal_remote' schema. Support for reading/writing the local revision_id will end with the v4 release.",
+                FutureWarning,
+            )
+        current_revision_id = remote_revision_id
+    except Exception:
+        assert current_revision_id is not None
     autogenerate_revision_file(
-        benchling_service, VERSIONS_DIR_PATH, description, current_revision_id
+        benchling_service,
+        VERSIONS_DIR_PATH,
+        description,
+        current_revision_id,
+        autogenerate,
+    )
+
+
+@app.command(
+    name="autogenerate",
+    hidden=True,
+)
+def autogenerate(
+    benchling_tenant: str = typer.Argument(
+        ..., help="Benchling tenant (or alias) to connect to."
+    ),
+    description: str = typer.Argument(
+        ...,
+        help="A description of the revision being generated. This will also be included in the file name.",
+    ),
+) -> None:
+    raise DeprecationWarning(
+        "CLI command `liminal autogenerate ...` is deprecated and will be removed in v4. Please use `liminal revision ...` instead."
     )
 
 
 @app.command(
     name="upgrade",
-    help="Upgrades the Benchling tenant by running revision file(s) based on the CURRENT_REVISION_ID and the passed in parameters. Runs the upgrade operations of each revision file in order.",
+    help="Upgrades the Benchling tenant by running revision file(s) based on the passed in parameters. Uses the remote revision_id in Benchling as the starting point, and upgrades to the given revision by running the operations in the revision file(s).",
     context_settings={"ignore_unknown_options": True},
 )
 def upgrade(
@@ -146,19 +209,35 @@ def upgrade(
     ),
     upgrade_descriptor: str = typer.Argument(
         ...,
-        help="Determines the revision files that get run. Pass in the 'revision_id' to upgrade to that revision. Pass in 'head' to upgrade to the latest revision. Pass in '+n' to make a relative revision based on the current revision id.",
+        help="Determines the revision files that get run. Pass in the 'revision_id' to upgrade to that revision. Pass in 'head' to upgrade to the latest revision. Pass in '+n' to make a relative revision based on the current remote revision id.",
     ),
 ) -> None:
     current_revision_id, benchling_connection = read_local_liminal_dir(
         LIMINAL_DIR_PATH, benchling_tenant
     )
+    local_revision_id_exists = current_revision_id is not None
     benchling_service = BenchlingService(benchling_connection, use_internal_api=True)
+    try:
+        remote_revision_id = benchling_service.get_remote_revision_id()
+        if current_revision_id is not None:
+            warnings.warn(
+                f"Accessing and using the revision_id variable in {LIMINAL_DIR_PATH/'env.py'} is deprecated. Delete the variable set in the env.py file, the revision_id is now stored in your Benchling tenant within the '_liminal_remote' schema. Support for reading/writing the local revision_id will end with the v4 release.",
+                FutureWarning,
+            )
+        current_revision_id = remote_revision_id
+    except Exception:
+        assert current_revision_id is not None
     upgrade_revision_id = upgrade_benchling_tenant(
         benchling_service, VERSIONS_DIR_PATH, current_revision_id, upgrade_descriptor
     )
-    update_env_revision_id(ENV_FILE_PATH, benchling_tenant, upgrade_revision_id)
+    benchling_service.upsert_remote_revision_id(upgrade_revision_id)
+    if local_revision_id_exists:
+        update_env_revision_id(ENV_FILE_PATH, benchling_tenant, upgrade_revision_id)
+        print(
+            f"[dim red]Set local {benchling_tenant}_CURRENT_REVISION_ID to {upgrade_revision_id} in liminal/env.py"
+        )
     print(
-        f"[dim]Set {benchling_tenant}_CURRENT_REVISION_ID to {upgrade_revision_id} in liminal/env.py"
+        f"[dim]Set revision_id to {upgrade_revision_id} withinn '_liminal_remote' schema."
     )
     print("[bold green]Migration complete")
 
@@ -180,13 +259,29 @@ def downgrade(
     current_revision_id, benchling_connection = read_local_liminal_dir(
         LIMINAL_DIR_PATH, benchling_tenant
     )
+    local_revision_id_exists = current_revision_id is not None
     benchling_service = BenchlingService(benchling_connection, use_internal_api=True)
+    try:
+        remote_revision_id = benchling_service.get_remote_revision_id()
+        if current_revision_id is not None:
+            warnings.warn(
+                f"Accessing and using the revision_id variable in {LIMINAL_DIR_PATH/'env.py'} is deprecated. Delete the variable set in the env.py file, the revision_id is now stored in your Benchling tenant within the '_liminal_remote' schema. Support for reading/writing the local revision_id will end with the v4 release.",
+                FutureWarning,
+            )
+        current_revision_id = remote_revision_id
+    except Exception:
+        assert current_revision_id is not None
     downgrade_revision_id = downgrade_benchling_tenant(
         benchling_service, VERSIONS_DIR_PATH, current_revision_id, downgrade_descriptor
     )
-    update_env_revision_id(ENV_FILE_PATH, benchling_tenant, downgrade_revision_id)
+    benchling_service.upsert_remote_revision_id(downgrade_revision_id)
+    if local_revision_id_exists:
+        update_env_revision_id(ENV_FILE_PATH, benchling_tenant, downgrade_revision_id)
+        print(
+            f"[dim red]Set local {benchling_tenant}_CURRENT_REVISION_ID to {downgrade_revision_id} in liminal/env.py"
+        )
     print(
-        f"[dim]Set {benchling_tenant}_CURRENT_REVISION_ID to {downgrade_revision_id} in liminal/env.py"
+        f"[dim]Set revision_id to {downgrade_revision_id} withinn '_liminal_remote' schema."
     )
     print("[bold green]Migration complete")
 
@@ -217,9 +312,7 @@ def live_test(
         raise ValueError(
             "Only one of --entity-schema-migration or --dropdown-migration can be set."
         )
-    current_revision_id, benchling_connection = read_local_liminal_dir(
-        LIMINAL_DIR_PATH, benchling_tenant
-    )
+    _, benchling_connection = read_local_liminal_dir(LIMINAL_DIR_PATH, benchling_tenant)
     benchling_service = BenchlingService(benchling_connection, use_internal_api=True)
     if test_entity_schema_migration:
         mock_entity_schema_full_migration(

{liminal_orm-3.1.1 → liminal_orm-3.2.1}/liminal/cli/controller.py

@@ -30,6 +30,7 @@ def autogenerate_revision_file(
     write_dir_path: Path,
     description: str,
     current_revision_id: str,
+    compare: bool = True,
 ) -> None:
     """Generates a revision file by comparing locally defined schemas to the given Benchling tenant.
     The revision file contains a unique revision id, the down_revision_id (which is the latest revision id that this revision is based on),
@@ -46,16 +47,20 @@ def autogenerate_revision_file(
         A description of the revision being generated. This will also be included in the file name.
     """
     revision_timeline = RevisionsTimeline(write_dir_path)
+    if current_revision_id not in revision_timeline.revisions_map.keys():
+        raise Exception(
+            f"Your target Benchling tenant is currently at revision_id {current_revision_id}. This does not exist within your revision timeline in any of your revision files. Ensure your current revision_id for your tenant is correct. The current local head revision is {revision_timeline.get_latest_revision().id}"
+        )
     if current_revision_id != revision_timeline.get_latest_revision().id:
         raise Exception(
-            f"Your target Benchling tenant is not up to date with the latest revision ({revision_timeline.get_latest_revision().id}). Please upgrade to the latest revision before generating a new revision."
+            f"Your target Benchling tenant is currently at revision_id {current_revision_id}, which is not up to date with the local head revision ({revision_timeline.get_latest_revision().id}). Please upgrade your tenant to the latest revision before generating a new revision."
         )
-    compare_ops = get_full_migration_operations(benchling_service)
-    write_path = revision_timeline.write_new_revision(description, compare_ops)
-    if write_path is None:
-        print("[bold green]No changes needed. Skipping revision file generation.")
+    if compare:
+        compare_ops = get_full_migration_operations(benchling_service)
     else:
-        print(f"[bold green]Revision file generated at {write_path}")
+        compare_ops = []
+    write_path = revision_timeline.write_new_revision(description, compare_ops)
+    print(f"[bold green]Revision file generated at {write_path}")
 
 
 def upgrade_benchling_tenant(

{liminal_orm-3.1.1 → liminal_orm-3.2.1}/liminal/cli/utils.py

@@ -1,8 +1,11 @@
 import importlib.util
+from logging import Logger
 from pathlib import Path
 
 from liminal.connection.benchling_connection import BenchlingConnection
 
+LOGGER = Logger(name=__name__)
+
 
 def _check_liminal_directory_initialized(liminal_dir_path: Path) -> None:
     """Raises an exception if the liminal directory does not exist at the given path."""
@@ -19,7 +22,7 @@ def _check_liminal_directory_initialized(liminal_dir_path: Path) -> None:
 
 def read_local_liminal_dir(
     liminal_dir_path: Path, benchling_tenant: str
-) -> tuple[str, BenchlingConnection]:
+) -> tuple[str | None, BenchlingConnection]:
     """Imports the env.py file from /liminal/env.py and returns the CURRENT_REVISION_ID variable along with the BenchlingConnection object.
     The env.py file is expected to have the CURRENT_REVISION_ID variable set to the revision id you are currently on.
     The BenchlingConnection object is expected to be defined and have connection information for the Benchling API client and internal API.
@@ -34,7 +37,7 @@ def read_local_liminal_dir(
 
 def _read_local_env_file(
     env_file_path: Path, benchling_tenant: str
-) -> tuple[str, BenchlingConnection]:
+) -> tuple[str | None, BenchlingConnection]:
     """Imports the env.py file from the current working directory and returns the CURRENT_REVISION_ID variable along with the BenchlingConnection object.
     The env.py file is expected to have the CURRENT_REVISION_ID variable set to the revision id you are currently on.
     The BenchlingConnection object is expected to be defined and have connection information for the Benchling API client and internal API.
@@ -62,8 +65,8 @@ def _read_local_env_file(
                     "internal_api_admin_email and internal_api_admin_password must be provided in BenchlingConnection in liminal/env.py. This is necessary for the migration service."
                 )
             try:
-                current_revision_id: str = getattr(
-                    module, bc.current_revision_id_var_name
+                current_revision_id: str | None = getattr(
+                    module, bc.current_revision_id_var_name, None
                 )
                 return current_revision_id, bc
             except Exception as e:
@@ -78,7 +81,7 @@ def _read_local_env_file(
 def update_env_revision_id(
     env_file_path: Path, benchling_env: str, revision_id: str
 ) -> None:
-    """Updates the CURRENT_REVISION_ID variable in the env.py file to the given revision id."""
+    """Updates the CURRENT_REVISION_ID variable in the env.py file to the given revision id. REMOVE WITH v4 release."""
     env_file_content = env_file_path.read_text().split("\n")
     for i, line in enumerate(env_file_content):
         if f"{benchling_env}_CURRENT_REVISION_ID =" in line:

liminal_orm-3.2.1/liminal/connection/__init__.py

@@ -0,0 +1,5 @@
+from liminal.connection.benchling_connection import (
+    BenchlingConnection,  # noqa: F401
+    TenantConfigFlags,  # noqa: F401
+)
+from liminal.connection.benchling_service import BenchlingService  # noqa: F401

{liminal_orm-3.1.1 → liminal_orm-3.2.1}/liminal/connection/benchling_service.py

@@ -16,10 +16,20 @@ from tenacity import (
     wait_exponential,
 )
 
+from liminal.base.properties.base_field_properties import BaseFieldProperties
+from liminal.base.properties.base_schema_properties import BaseSchemaProperties
 from liminal.connection.benchling_connection import BenchlingConnection
+from liminal.enums import (
+    BenchlingEntityType,
+    BenchlingFieldType,
+    BenchlingNamingStrategy,
+)
 
 logger = logging.getLogger(__name__)
 
+REMOTE_LIMINAL_SCHEMA_NAME = "_liminal_remote"
+REMOTE_REVISION_ID_FIELD_WH_NAME = "revision_id"
+
 
 class BenchlingService(Benchling):
     """
@@ -138,6 +148,99 @@ class BenchlingService(Benchling):
         """Closes all sessions and cleans up engine"""
         self.engine.dispose()
 
+    def get_remote_revision_id(self) -> str:
+        """
+        Uses internal API to to search for the _liminal_remote schema, where the revision_id is stored.
+        This schema contains the remote revision_id in the name of the revision_id field.
+
+        Returns the remote revision_id stored on the entity.
+        """
+        from liminal.entity_schemas.tag_schema_models import TagSchemaModel
+
+        try:
+            liminal_schema = TagSchemaModel.get_one(self, REMOTE_LIMINAL_SCHEMA_NAME)
+        except Exception:
+            raise ValueError(
+                f"Did not find any schema name '{REMOTE_LIMINAL_SCHEMA_NAME}'. Run a liminal migration to populate your registry with the Liminal entity that stores the remote revision_id."
+            )
+        revision_id_fields = [
+            f
+            for f in liminal_schema.fields
+            if f.systemName == REMOTE_REVISION_ID_FIELD_WH_NAME
+        ]
+        if len(revision_id_fields) == 1:
+            revision_id = revision_id_fields[0].name
+            assert revision_id is not None, "No revision_id set in field name."
+            return revision_id
+        else:
+            raise ValueError(
+                f"Error finding field on {REMOTE_LIMINAL_SCHEMA_NAME} schema with warehouse_name {REMOTE_REVISION_ID_FIELD_WH_NAME}. Check schema fields to ensure this field exists and is defined according to documentation."
+            )
+
+    def upsert_remote_revision_id(self, revision_id: str) -> None:
+        """Updates or inserts a remote Liminal schema into your tenant with the given revision_id stored in the name of a field.
+        If the '_liminal_remote' schema is found, check and make sure a field with warehouse_name 'revision_id' is present. If both are present, update the revision_id stored within the name.
+        If no schema is found, create the _liminal_remote entity schema.
+        Upsert is needed to migrate users from using the CURRENT_REVISION_ID stored in the env.py file smoothly to storing in Benchling itself.
+
+        Parameters
+        ----------
+        revision_id : str
+            revision_id of migration file to set in Benchling on remote liminal entity.
+
+        Returns
+        -------
+        CustomEntity
+            remote liminal entity with updated revision_id field.
+        """
+        from liminal.entity_schemas.tag_schema_models import TagSchemaModel
+
+        try:
+            liminal_schema = TagSchemaModel.get_one(self, REMOTE_LIMINAL_SCHEMA_NAME)
+        except Exception:
+            # No _liminal_remote schema found. Create schema.
+            from liminal.entity_schemas.operations import CreateEntitySchema
+
+            CreateEntitySchema(
+                schema_properties=BaseSchemaProperties(
+                    name={REMOTE_LIMINAL_SCHEMA_NAME},
+                    warehouse_name={REMOTE_LIMINAL_SCHEMA_NAME},
+                    prefix={REMOTE_LIMINAL_SCHEMA_NAME},
+                    entity_type=BenchlingEntityType.CUSTOM_ENTITY,
+                    naming_strategies={BenchlingNamingStrategy.NEW_IDS},
+                ),
+                fields=[
+                    BaseFieldProperties(
+                        name={revision_id},
+                        warehouse_name=REMOTE_REVISION_ID_FIELD_WH_NAME,
+                        type=BenchlingFieldType.TEXT,
+                        parent_link=False,
+                        is_multi=False,
+                        required=True,
+                    )
+                ],
+            ).execute(self)
+        # _liminal_remote schema found. Check if revision_id field exists on it.
+        revision_id_fields = [
+            f
+            for f in liminal_schema.fields
+            if f.systemName == REMOTE_REVISION_ID_FIELD_WH_NAME
+        ]
+        if len(revision_id_fields) == 1:
+            # _liminal_remote schema found, revision_id field found. Update revision_id field on it with given revision_id.
+            from liminal.entity_schemas.operations import UpdateEntitySchemaField
+
+            revision_id_field = revision_id_fields[0]
+            UpdateEntitySchemaField(
+                liminal_schema.sqlIdentifier,
+                revision_id_field.systemName,
+                BaseFieldProperties(name=revision_id),
+            ).execute(self)
+        else:
+            raise ValueError(
+                f"Error finding field on {REMOTE_LIMINAL_SCHEMA_NAME} schema with warehouse_name {REMOTE_REVISION_ID_FIELD_WH_NAME}. Check schema fields to ensure this field exists and is defined according to documentation."
+            )
+
     @classmethod
     @retry(
         stop=stop_after_attempt(3),