Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ndamania00 committed Feb 12, 2025
1 parent 52e331d commit 6129120
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/reference/entity-schemas.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,11 @@ All Liminal entity schema classes must inherit from one of the mixins in the [mi

- **constraint_fields: set[str] | None**

Set of constraints for field values for the schema. Must be a set of column names that specify that their values must be a unique combination within an entity. If the entity type is a Sequence, "bases" can be a constraint field.
Set of constraints for field values for the schema. Must be a set of warehouse column names. This specifies that their entity field values must be a unique combination within an entity.
The following sequence constraints are also supported:
- `'bases'`: only supported for nucleotide sequence entity types. hasUniqueResidues=True
- `'amino_acids_ignore_case'`: only supported for amino acid sequence entity types. hasUniqueResidues=True
- `'amino_acids_exact_match'`: only supported for amino acid sequence entity types. hasUniqueResidues=True, areUniqueResiduesCaseSensitive=True

- **_archived: bool | None = None**

Expand Down
4 changes: 4 additions & 0 deletions liminal/base/properties/base_schema_properties.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ class BaseSchemaProperties(BaseModel):
Flag for configuring the chip label for entities. Determines if the chip will include the Registry ID in the chip label.
constraint_fields : set[str] | None
Set of constraints for field values for the schema. Must be a set of warehouse column names. This specifies that their entity field values must be a unique combination within an entity.
The following sequence constraints are also supported:
- bases: only supported for nucleotide sequence entity types. hasUniqueResidues=True
- amino_acids_ignore_case: only supported for amino acid sequence entity types. hasUniqueResidues=True
- amino_acids_exact_match: only supported for amino acid sequence entity types. hasUniqueResidues=True, areUniqueResiduesCaseSensitive=True
_archived : bool | None
Whether the schema is archived in Benchling.
"""
Expand Down
4 changes: 4 additions & 0 deletions liminal/orm/schema_properties.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ class SchemaProperties(BaseSchemaProperties):
Flag for configuring the chip label for entities. Determines if the chip will include the Registry ID in the chip label.
constraint_fields : set[str]
Set of constraints for field values for the schema. Must be a set of warehouse column names. This specifies that their entity field values must be a unique combination within an entity.
The following sequence constraints are also supported:
- bases: only supported for nucleotide sequence entity types. hasUniqueResidues=True
- amino_acids_ignore_case: only supported for amino acid sequence entity types. hasUniqueResidues=True
- amino_acids_exact_match: only supported for amino acid sequence entity types. hasUniqueResidues=True, areUniqueResiduesCaseSensitive=True
_archived : bool | None
Whether the schema is archived in Benchling.
"""
Expand Down

0 comments on commit 6129120

Please sign in to comment.