Skip to content

Commit

Permalink
Merge pull request #128 from slaarti/filter_link_fix
Browse files Browse the repository at this point in the history
Correct links to advanced filters in docstrings?
  • Loading branch information
igorbenav authored Jul 26, 2024
2 parents 9582c1c + bdd897f commit bebc9c8
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions fastcrud/crud/fast_crud.py
Original file line number Diff line number Diff line change
Expand Up @@ -431,7 +431,7 @@ async def select(
This method allows for advanced filtering through comparison operators, enabling queries to be refined beyond simple equality checks.
For filtering details see [the Advanced Filters documentation](../../advanced/crud/#advanced-filters)
For filtering details see [the Advanced Filters documentation](../advanced/crud.md/#advanced-filters)
Args:
schema_to_select: Pydantic schema to determine which columns to include in the selection. If not provided, selects all columns of the model.
Expand Down Expand Up @@ -493,7 +493,7 @@ async def get(
This method allows for advanced filtering through comparison operators, enabling queries to be refined beyond simple equality checks.
For filtering details see [the Advanced Filters documentation](../../advanced/crud/#advanced-filters)
For filtering details see [the Advanced Filters documentation](../advanced/crud.md/#advanced-filters)
Args:
db: The database session to use for the operation.
Expand Down Expand Up @@ -718,7 +718,7 @@ async def exists(self, db: AsyncSession, **kwargs: Any) -> bool:
"""
Checks if any records exist that match the given filter conditions.
For filtering details see [the Advanced Filters documentation](../../advanced/crud/#advanced-filters)
For filtering details see [the Advanced Filters documentation](../advanced/crud.md/#advanced-filters)
Args:
db: The database session to use for the operation.
Expand Down Expand Up @@ -763,7 +763,7 @@ async def count(
"""
Counts records that match specified filters.
For filtering details see [the Advanced Filters documentation](../../advanced/crud/#advanced-filters)
For filtering details see [the Advanced Filters documentation](../advanced/crud.md/#advanced-filters)
Can also count records based on a configuration of joins, useful for complex queries involving relationships.
Expand Down Expand Up @@ -886,7 +886,7 @@ async def get_multi(
"""
Fetches multiple records based on filters, supporting sorting, pagination.
For filtering details see [the Advanced Filters documentation](../../advanced/crud/#advanced-filters)
For filtering details see [the Advanced Filters documentation](../advanced/crud.md/#advanced-filters)
Args:
db: The database session to use for the operation.
Expand Down Expand Up @@ -1032,7 +1032,7 @@ async def get_joined(
to automatically detect the join condition using foreign key relationships. For multiple joins, use `joins_config` to
specify each join configuration.
For filtering details see [the Advanced Filters documentation](../../advanced/crud/#advanced-filters)
For filtering details see [the Advanced Filters documentation](../advanced/crud.md/#advanced-filters)
Args:
db: The SQLAlchemy async session.
Expand Down Expand Up @@ -1339,7 +1339,7 @@ async def get_multi_joined(
"""
Fetch multiple records with a join on another model, allowing for pagination, optional sorting, and model conversion.
For filtering details see [the Advanced Filters documentation](../../advanced/crud/#advanced-filters)
For filtering details see [the Advanced Filters documentation](../advanced/crud.md/#advanced-filters)
Args:
db: The SQLAlchemy async session.
Expand Down Expand Up @@ -1720,7 +1720,7 @@ async def get_multi_by_cursor(
"""
Implements cursor-based pagination for fetching records. This method is designed for efficient data retrieval in large datasets and is ideal for features like infinite scrolling.
For filtering details see [the Advanced Filters documentation](../../advanced/crud/#advanced-filters)
For filtering details see [the Advanced Filters documentation](../advanced/crud.md/#advanced-filters)
Args:
db: The SQLAlchemy async session.
Expand Down Expand Up @@ -1830,7 +1830,7 @@ async def update(
"""
Updates an existing record or multiple records in the database based on specified filters. This method allows for precise targeting of records to update.
For filtering details see [the Advanced Filters documentation](../../advanced/crud/#advanced-filters)
For filtering details see [the Advanced Filters documentation](../advanced/crud.md/#advanced-filters)
Args:
db: The database session to use for the operation.
Expand Down Expand Up @@ -2000,7 +2000,7 @@ async def db_delete(
"""
Deletes a record or multiple records from the database based on specified filters.
For filtering details see [the Advanced Filters documentation](../../advanced/crud/#advanced-filters)
For filtering details see [the Advanced Filters documentation](../advanced/crud.md/#advanced-filters)
Args:
db: The database session to use for the operation.
Expand Down Expand Up @@ -2060,7 +2060,7 @@ async def delete(
"""
Soft deletes a record or optionally multiple records if it has an `"is_deleted"` attribute, otherwise performs a hard delete, based on specified filters.
For filtering details see [the Advanced Filters documentation](../../advanced/crud/#advanced-filters)
For filtering details see [the Advanced Filters documentation](../advanced/crud.md/#advanced-filters)
Args:
db: The database session to use for the operation.
Expand Down

0 comments on commit bebc9c8

Please sign in to comment.