liminal-orm 4.7.0__tar.gz → 5.0.0__tar.gz

{liminal_orm-4.7.0 → liminal_orm-5.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: liminal-orm
-Version: 4.7.0
+Version: 5.0.0
 Summary: An ORM and toolkit that builds on top of Benchling's platform to keep your schemas and downstream code dependencies in sync.
 Project-URL: Homepage, https://github.com/dynotx/liminal-orm
 Project-URL: Repository, https://github.com/dynotx/liminal-orm
@@ -15,9 +15,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Python: <3.14,>=3.10
 Requires-Dist: benchling-sdk<2,>=1.21.2
-Requires-Dist: bs4<0.0.3,>=0.0.2
 Requires-Dist: click<8.2.0,>=8.0.0
-Requires-Dist: lxml<6,>=5.3.0
 Requires-Dist: numpy<2,>=1.23.5; python_version < '3.12'
 Requires-Dist: numpy<2,>=1.26; python_version == '3.12'
 Requires-Dist: numpy<3,>=2.1; python_version == '3.13'
@@ -25,14 +23,11 @@ Requires-Dist: pandas<3,>=1.5.3; python_version == '3.10'
 Requires-Dist: pandas<4,>=1.5.3; python_version == '3.11'
 Requires-Dist: pandas<4,>=2.2.3; python_version == '3.13'
 Requires-Dist: pandas<4,>=2.2; python_version == '3.12'
-Requires-Dist: playwright>=1.58.0
 Requires-Dist: psycopg2-binary<3,>=2.9.10
 Requires-Dist: pydantic<=2.13,>=2
-Requires-Dist: requests<3,>=2.32.3
 Requires-Dist: rich<14,>=13.9.2
 Requires-Dist: sqlalchemy<2,>=1.4.53
 Requires-Dist: tenacity<10,>=8
-Requires-Dist: tornado==6.5.0
 Requires-Dist: typer<0.13,>=0.12.5
 Description-Content-Type: text/markdown
 

{liminal_orm-4.7.0 → liminal_orm-5.0.0}/liminal/base/base_operation.py

@@ -9,20 +9,21 @@ Order of operations based on order class var:
     2. UpdateDropdownName
     3. UnarchiveDropdown
     4. CreateDropdownOption
-    5. UpdateDropdownOption
-    6. ArchiveDropdownOption
-    7. ReorderDropdownOptions
-    8. CreateSchema
-    9. UnarchiveSchema
-    10. CreateField
-    11. UpdateEntitySchemaNameTemplate
-    12. UpdateSchema
-    13. UnarchiveField
-    14. UpdateField
-    15. ArchiveField
-    16. ReorderFields
-    17. ArchiveSchema
-    18. ArchiveDropdown
+    5. UnarchiveDropdownOption
+    6. UpdateDropdownOption
+    7. ArchiveDropdownOption
+    8. ReorderDropdownOptions
+    9. CreateEntitySchema
+    10. UnarchiveEntitySchema
+    11. CreateEntitySchemaField
+    12. UpdateEntitySchemaNameTemplate
+    13. UpdateEntitySchema
+    14. UnarchiveEntitySchemaField
+    15. UpdateEntitySchemaField
+    16. ArchiveEntitySchemaField
+    17. ReorderEntitySchemaFields
+    18. ArchiveEntitySchema
+    19. ArchiveDropdown
 """
 
 

{liminal_orm-4.7.0 → liminal_orm-5.0.0}/liminal/base/name_template_parts.py

@@ -3,6 +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. This will be removed in v5.",
+    "Importing from 'liminal.base.name_template_parts' is deprecated. Please import from 'liminal.orm.name_template_parts' instead. This will be removed in v6.",
     FutureWarning,
 )

{liminal_orm-4.7.0 → liminal_orm-5.0.0}/liminal/base/properties/base_field_properties.py

@@ -56,6 +56,23 @@ class BaseFieldProperties(BaseModel):
         super().__init__(**data)
         self._archived = data.get("_archived", None)
 
+    @staticmethod
+    def unsupported_field_properties(
+        field_type: BenchlingFieldType, has_entity_link: bool
+    ) -> set[str]:
+        """Returns the properties that Benchling does not support for the given field type."""
+        unsupported: set[str] = set()
+        non_multi_types = BenchlingFieldType.get_non_multi_select_types()
+        if field_type in non_multi_types:
+            unsupported.add("is_multi")
+        if not (has_entity_link and field_type == BenchlingFieldType.ENTITY_LINK):
+            unsupported.add("parent_link")
+        if field_type not in BenchlingFieldType.get_number_field_types():
+            unsupported.add("unit_name")
+        if field_type != BenchlingFieldType.DECIMAL:
+            unsupported.add("decimal_places")
+        return unsupported
+
     def set_archived(self, value: bool) -> BaseFieldProperties:
         self._archived = value
         return self

{liminal_orm-4.7.0 → liminal_orm-5.0.0}/liminal/cli/cli.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python
 from pathlib import Path
 from typing import Any
+
 import typer
 from rich import print
 from typer.core import TyperGroup
@@ -67,8 +68,6 @@ connection = BenchlingConnection(
     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(...)
 )
 """
@@ -119,7 +118,7 @@ def generate_files(
     ),
 ) -> None:
     benchling_connection = read_local_liminal_dir(LIMINAL_DIR_PATH, benchling_tenant)
-    benchling_service = BenchlingService(benchling_connection, use_internal_api=True)
+    benchling_service = BenchlingService(benchling_connection)
     if not write_path.exists():
         write_path.mkdir()
         print(f"[green]Created directory: {write_path}")
@@ -147,17 +146,33 @@ def current(
     ),
 ) -> None:
     benchling_connection = read_local_liminal_dir(LIMINAL_DIR_PATH, benchling_tenant)
-    benchling_service = BenchlingService(benchling_connection, use_internal_api=True)
+    benchling_service = BenchlingService(benchling_connection)
     remote_revision_id = benchling_service.get_remote_revision_id()
     print(f"[blue]Current remote revision_id: {remote_revision_id}.")
 
 
 @app.command(
     name="head",
-    help="Returns the local heads, or the latest revision_id, in your linear revision timeline.",
+    help="Returns the local heads, or the latest revision_id, in your linear revision timeline. Pass --reset to delete the local head revision file.",
 )
-def head() -> None:
+def head(
+    reset: bool = typer.Option(
+        False,
+        "-r",
+        "--reset",
+        help="Deletes the local head revision file, making its down_revision the new head. Only use this for revisions that have not been applied to any tenant.",
+    ),
+) -> None:
     revision_timeline = RevisionsTimeline(VERSIONS_DIR_PATH)
+    if reset:
+        latest_revision = revision_timeline.get_latest_revision()
+        file_path = VERSIONS_DIR_PATH / latest_revision.revision_file_name
+        print(
+            f"[bold yellow]Delete local head revision file {latest_revision.id} ({file_path})?[/bold yellow]"
+        )
+        typer.confirm("Confirm", abort=True)
+        revision_timeline.delete_latest_revision()
+        print(f"[dim]Deleted revision file {file_path}.")
     print(f"[blue]{revision_timeline.get_latest_revision().id}: (head)[/blue]")
 
 
@@ -180,7 +195,7 @@ def revision(
     ),
 ) -> None:
     benchling_connection = read_local_liminal_dir(LIMINAL_DIR_PATH, benchling_tenant)
-    benchling_service = BenchlingService(benchling_connection, use_internal_api=True)
+    benchling_service = BenchlingService(benchling_connection)
     revisions_timeline = RevisionsTimeline(VERSIONS_DIR_PATH)
     is_init_revision = revisions_timeline.is_only_init_revision()
     if is_init_revision:
@@ -214,7 +229,7 @@ def autogenerate(
     ),
 ) -> None:
     raise DeprecationWarning(
-        "CLI command `liminal autogenerate ...` is deprecated and will be removed in v5. Please use `liminal revision ...` instead."
+        "CLI command `liminal autogenerate ...` is deprecated and will be removed in v6. Please use `liminal revision ...` instead."
     )
 
 
@@ -233,7 +248,7 @@ def upgrade(
     ),
 ) -> None:
     benchling_connection = read_local_liminal_dir(LIMINAL_DIR_PATH, benchling_tenant)
-    benchling_service = BenchlingService(benchling_connection, use_internal_api=True)
+    benchling_service = BenchlingService(benchling_connection)
     current_revision_id = benchling_service.get_remote_revision_id()
     revisions_timeline = RevisionsTimeline(VERSIONS_DIR_PATH)
     upgrade_revision_id = upgrade_benchling_tenant(
@@ -261,7 +276,7 @@ def downgrade(
     ),
 ) -> None:
     benchling_connection = read_local_liminal_dir(LIMINAL_DIR_PATH, benchling_tenant)
-    benchling_service = BenchlingService(benchling_connection, use_internal_api=True)
+    benchling_service = BenchlingService(benchling_connection)
     current_revision_id = benchling_service.get_remote_revision_id()
     revisions_timeline = RevisionsTimeline(VERSIONS_DIR_PATH)
     downgrade_revision_id = downgrade_benchling_tenant(
@@ -301,7 +316,7 @@ def live_test(
             "Only one of --entity-schema-migration or --dropdown-migration can be set."
         )
     benchling_connection = read_local_liminal_dir(LIMINAL_DIR_PATH, benchling_tenant)
-    benchling_service = BenchlingService(benchling_connection, use_internal_api=True)
+    benchling_service = BenchlingService(benchling_connection)
     if test_entity_schema_migration:
         mock_entity_schema_full_migration(
             benchling_service, "test_dont_touch", dry_run=not execute

{liminal_orm-4.7.0 → liminal_orm-5.0.0}/liminal/cli/controller.py

@@ -76,7 +76,7 @@ def autogenerate_revision_file(
         )
     if current_revision_id != revisions_timeline.get_latest_revision().id:
         raise Exception(
-            f"Your target Benchling tenant is currently at revision_id {current_revision_id}, which is not up to date with the local head revision ({revisions_timeline.get_latest_revision().id}). Please upgrade your tenant 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 ({revisions_timeline.get_latest_revision().id}). Please upgrade your tenant to the latest revision before generating a new revision. If the local head revision should not be applied, run `liminal head --reset` to delete it."
         )
     if compare:
         compare_ops = get_full_migration_operations(benchling_service)

{liminal_orm-4.7.0 → liminal_orm-5.0.0}/liminal/cli/live_test_entity_schema_migration.py

@@ -1,5 +1,6 @@
 from liminal.base.base_operation import BaseOperation
 from liminal.base.properties.base_field_properties import BaseFieldProperties
+from liminal.base.properties.base_name_template import BaseNameTemplate
 from liminal.base.properties.base_schema_properties import BaseSchemaProperties
 from liminal.connection.benchling_service import BenchlingService
 from liminal.entity_schemas.operations import (
@@ -12,6 +13,7 @@ from liminal.entity_schemas.operations import (
     UnarchiveEntitySchemaField,
     UpdateEntitySchema,
     UpdateEntitySchemaField,
+    UpdateEntitySchemaNameTemplate,
 )
 from liminal.enums import (
     BenchlingEntityType,
@@ -19,6 +21,7 @@ from liminal.enums import (
     BenchlingNamingStrategy,
 )
 from liminal.migrate.components import execute_operations, execute_operations_dry_run
+from liminal.orm.name_template_parts import FieldPart, SeparatorPart, TextPart
 from liminal.orm.schema_properties import SchemaProperties
 from liminal.utils import generate_random_id
 
@@ -122,6 +125,18 @@ def mock_entity_schema_full_migration(
         ["test_column_1", "test_column_2", "test_column_3", "test_column_4"],
     )
 
+    update_name_template_op = UpdateEntitySchemaNameTemplate(
+        test_model_wh_name,
+        BaseNameTemplate(
+            parts=[
+                TextPart(value="TEST"),
+                SeparatorPart(value="-"),
+                FieldPart(wh_field_name="test_column_1"),
+            ],
+            order_name_parts_by_sequence=False,
+        ),
+    )
+
     archive_entity_schema_op = ArchiveEntitySchema(test_model_wh_name)
     unarchive_entity_schema_op = UnarchiveEntitySchema(test_model_wh_name)
     rearchive_entity_schema_op = ArchiveEntitySchema(test_model_wh_name)
@@ -134,6 +149,7 @@ def mock_entity_schema_full_migration(
         archive_entity_schema_field_op,
         unarchive_entity_schema_field_op,
         reorder_entity_schema_field_op,
+        update_name_template_op,
         archive_entity_schema_op,
         unarchive_entity_schema_op,
         rearchive_entity_schema_op,

{liminal_orm-4.7.0 → liminal_orm-5.0.0}/liminal/cli/utils.py

@@ -25,7 +25,7 @@ def read_local_liminal_dir(
     liminal_dir_path: Path, benchling_tenant: str
 ) -> BenchlingConnection:
     """Imports the env.py file from /liminal/env.py and returns the BenchlingConnection object.
-    The BenchlingConnection object is expected to be defined and have connection information for the Benchling API client and internal API.
+    The BenchlingConnection object is expected to be defined and have connection information for the Benchling API client.
     """
     _check_liminal_directory_initialized(liminal_dir_path)
     env_file_path = liminal_dir_path / "env.py"
@@ -36,7 +36,7 @@ def _read_local_env_file(
     env_file_path: Path, benchling_tenant: str
 ) -> BenchlingConnection:
     """Imports the env.py file from the current working directory and returns the BenchlingConnection object.
-    The BenchlingConnection object is expected to be defined and have connection information for the Benchling API client and internal API.
+    The BenchlingConnection object is expected to be defined and have connection information for the Benchling API client.
     """
     module_path = Path.cwd() / env_file_path
     spec = importlib.util.spec_from_file_location(env_file_path.stem, module_path)

{liminal_orm-4.7.0 → liminal_orm-5.0.0}/liminal/connection/benchling_connection.py

@@ -1,5 +1,6 @@
 import keyword
 import re
+import warnings
 
 from pydantic import BaseModel, model_validator
 
@@ -37,14 +38,11 @@ class BenchlingConnection(BaseModel):
     warehouse_connection_string: str | None = None
         The connection string for the warehouse.
     internal_api_admin_email: str | None = None
-        The email of the internal API admin. If SSO is not enabled or optional on your Benchling tenant, this email is used to log in to Benchling, and give Liminal the authenticated internal API session cookie.
+        DEPRECATED: Liminal no longer uses Benchling's internal API, so this is ignored. It will be removed in v6.
     internal_api_admin_password: str | None = None
-        The password of the internal API admin. If SSO is not enabled or optional on your Benchling tenant, this password is used to log in to Benchling, and give Liminal the authenticated internal API session cookie.
-    playwright_data_dir: str | None = "~/.liminal/chrome_data/"
-        The directory to store the playwright browser user data. If SSO is enabled and required on your Benchling tenant,
-        Liminal uses playwright so the user can log into Benchling in order to give Liminal the authenticated internal API session cookie.
-        This directory is used to store playwright's persistent context, allowing the user to set up a persistent chrome profile.
-        Set this to None in order to disable playwright's persistent context which enables automatic login.
+        DEPRECATED: Liminal no longer uses Benchling's internal API, so this is ignored. It will be removed in v6.
+    playwright_data_dir: str | None = None
+        DEPRECATED: Liminal no longer uses Playwright to log into Benchling's internal API, so this is ignored. It will be removed in v6.
     fieldsets: bool = False
         Whether your Benchling tenant has access to fieldsets.
     config_flags: TenantConfigFlags = TenantConfigFlags()
@@ -59,7 +57,7 @@ class BenchlingConnection(BaseModel):
     warehouse_connection_string: str | None = None
     internal_api_admin_email: str | None = None
     internal_api_admin_password: str | None = None
-    playwright_data_dir: str | None = "~/.liminal/playwright_chrome_data/"
+    playwright_data_dir: str | None = None
     fieldsets: bool = False
     config_flags: TenantConfigFlags = TenantConfigFlags()
 
@@ -81,3 +79,26 @@ class BenchlingConnection(BaseModel):
 
             values["current_revision_id_var_name"] = var_name
         return values
+
+    @model_validator(mode="after")
+    def warn_deprecated_internal_api_credentials(self) -> "BenchlingConnection":
+        if (
+            self.internal_api_admin_email is not None
+            or self.internal_api_admin_password is not None
+        ):
+            warnings.warn(
+                "Deprecated BenchlingConnection properties set: internal_api_admin_email and internal_api_admin_password. Liminal no longer uses Benchling's internal API, so they are ignored. Remove them from your BenchlingConnection, since they will be removed in v6.",
+                FutureWarning,
+                stacklevel=3,
+            )
+        return self
+
+    @model_validator(mode="after")
+    def warn_deprecated_playwright_data_dir(self) -> "BenchlingConnection":
+        if self.playwright_data_dir is not None:
+            warnings.warn(
+                "Deprecated BenchlingConnection property set: playwright_data_dir. Liminal no longer uses Playwright to log into Benchling, so it is ignored. Remove it from your BenchlingConnection, since it will be removed in v6.",
+                FutureWarning,
+                stacklevel=3,
+            )
+        return self

liminal_orm-5.0.0/liminal/connection/benchling_service.py

@@ -0,0 +1,245 @@
+import logging
+import warnings
+from typing import TYPE_CHECKING, Any
+
+from benchling_sdk.auth.client_credentials_oauth2 import ClientCredentialsOAuth2
+from benchling_sdk.benchling import Benchling, BenchlingApiClientDecorator
+from benchling_sdk.helpers.retry_helpers import RetryStrategy
+from sqlalchemy import create_engine
+from sqlalchemy.engine import Engine
+from sqlalchemy.orm import Session, configure_mappers
+
+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,
+)
+
+if TYPE_CHECKING:
+    from liminal.entity_schemas.entity_schema_models import EntitySchemaModel
+
+LOGGER = logging.getLogger(__name__)
+logging.getLogger("httpx").setLevel(logging.WARNING)
+
+REMOTE_LIMINAL_SCHEMA_NAME = "liminal_remote"
+REMOTE_REVISION_ID_FIELD_WH_NAME = "revision_id"
+
+
+class BenchlingService(Benchling):
+    """
+    Class that creates a connection object that can be used to connect to Benchling's API and/or Postgres warehouse.
+
+    Parameters
+    ----------
+    connection: BenchlingConnection
+        The connection object that contains the credentials for the Benchling tenant.
+    use_api: bool
+        Whether to connect to the Benchling SDK. Requires api_client_id and api_client_secret from the connection object.
+    use_db: bool = False
+        Whether to connect to the Benchling Postgres database. Requires warehouse_connection_string from the connection object.
+    use_internal_api: bool = False
+        DEPRECATED: Liminal no longer uses Benchling's internal API, so this is ignored. It will be removed in v6.
+    client_decorator: BenchlingApiClientDecorator | None = None
+        An optional function that receives the default BenchlingApiClient and returns a
+        customized one. Forwarded to the Benchling SDK. A common use is raising the HTTP
+        timeout, which otherwise defaults to 10 seconds: ``lambda c: c.with_timeout(60)``.
+    """
+
+    def __init__(
+        self,
+        connection: BenchlingConnection,
+        use_api: bool = True,
+        use_db: bool = False,
+        use_internal_api: bool = False,
+        client_decorator: BenchlingApiClientDecorator | None = None,
+    ) -> None:
+        if use_internal_api:
+            warnings.warn(
+                "Deprecated BenchlingService argument set: use_internal_api. Liminal no longer uses Benchling's internal API, so it is ignored. Remove it from your BenchlingService, since it will be removed in v6.",
+                FutureWarning,
+                stacklevel=2,
+            )
+        self.connection = connection
+        self._session: Session | None = None
+        self.use_api = use_api
+        self.benchling_tenant = connection.tenant_name
+        if use_api:
+            retry_strategy = RetryStrategy(max_tries=10)
+            auth_method = ClientCredentialsOAuth2(
+                client_id=connection.api_client_id,
+                client_secret=connection.api_client_secret,
+                token_url=f"https://{connection.tenant_name}.benchling.com/api/v2/token",
+            )
+            url = f"https://{connection.tenant_name}.benchling.com"
+            super().__init__(
+                url=url,
+                auth_method=auth_method,
+                retry_strategy=retry_strategy,
+                client_decorator=client_decorator,
+            )
+            LOGGER.info(f"Tenant {connection.tenant_name}: Connected to Benchling API.")
+        self.use_db = use_db
+        if use_db:
+            if connection.warehouse_connection_string:
+                self.engine: Engine = create_engine(
+                    connection.warehouse_connection_string
+                )
+                configure_mappers()
+                LOGGER.info(
+                    f"Tenant {connection.tenant_name}: Connected to Benchling read-only Postgres warehouse."
+                )
+            else:
+                raise ValueError(
+                    "use_db is True but warehouse_connection_string not provided in BenchlingConnection."
+                )
+
+    @property
+    def session(self) -> Session:
+        """Returns a session made by the sessionmaker"""
+        return self.get_session()
+
+    @property
+    def registry_id(self) -> str:
+        # This assumes there is only one registry (which has always been the case at DynoTx)
+        registries = self.registry.registries()
+        assert len(registries) == 1
+        return registries[0].id
+
+    @property
+    def organization_id(self) -> str:
+        # This assumes there is only one registry (which has always been the case at DynoTx)
+        registries = self.registry.registries()
+        assert len(registries) == 1
+        return registries[0].owner.id
+
+    def __enter__(self) -> Session:
+        self._session = self.get_session()
+        return self._session
+
+    def __exit__(self, exc_type: Any, exc_val: Any, exc_tb: Any) -> None:
+        if exc_val:
+            self._session.rollback()
+        self._session.close()
+        self._session = None
+
+    def get_session(self) -> Session:
+        """Provides a wrapper around getting sessions which enables batch inserts"""
+        if not self.use_db:
+            raise ValueError(
+                "Database connection not initialized! Initialize with 'use_db = True'"
+            )
+        session = Session(self.engine)
+        session.info["environment"] = self.connection.tenant_name
+        return session
+
+    def cleanup(self) -> None:
+        """Closes all sessions and cleans up engine"""
+        self.engine.dispose()
+
+    def _get_remote_liminal_schema(self) -> "EntitySchemaModel | None":
+        """Fetches the liminal_remote entity schema with its field definitions.
+        Returns None if the schema doesn't exist."""
+        from liminal.entity_schemas.entity_schema_models import EntitySchemaModel
+
+        try:
+            return EntitySchemaModel.get_one(self, REMOTE_LIMINAL_SCHEMA_NAME)
+        except ValueError:
+            return None
+
+    def get_remote_revision_id(self) -> str:
+        """
+        Searches 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.
+        """
+
+        liminal_schema = self._get_remote_liminal_schema()
+        if liminal_schema is None:
+            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 and not f.archived
+        ]
+        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) -> bool:
+        """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.
+
+        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.
+        """
+        liminal_schema = self._get_remote_liminal_schema()
+        if liminal_schema is None:
+            # 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)
+            LOGGER.info(
+                f"Created {REMOTE_LIMINAL_SCHEMA_NAME} schema for tracking the remote revision id."
+            )
+            return True
+        # 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 and not f.archived
+        ]
+        if len(revision_id_fields) == 1:
+            revision_id_field = revision_id_fields[0]
+            if revision_id_field.name == revision_id:
+                return False
+            else:
+                # 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
+
+                UpdateEntitySchemaField(
+                    liminal_schema.systemName,
+                    revision_id_field.systemName,
+                    BaseFieldProperties(name=revision_id),
+                ).execute(self)
+                return True
+        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."
+            )