clear-skies 1.22.31__py3-none-any.whl → 2.0.1__py3-none-any.whl

clearskies/model.py

@@ -1,42 +1,241 @@
-from abc import abstractmethod
-from collections import OrderedDict
-from .column_types import UUID
-from .functional import string
+from __future__ import annotations
+
 import re
-from .models import Models
+from abc import abstractmethod
+from typing import TYPE_CHECKING, Any, Callable, Iterator, Self
+
+from clearskies.autodoc.schema import Schema as AutoDocSchema
+from clearskies.di import InjectableProperties, inject
+from clearskies.functional import string
+from clearskies.query import Condition, Join, Query, Sort
+from clearskies.schema import Schema
+
+if TYPE_CHECKING:
+    from clearskies import Column
+    from clearskies.backends import Backend
+
+
+class Model(Schema, InjectableProperties):
+    """
+    A clearskies model.
+
+    To be useable, a model class needs four things:
+
+     1. The name of the id column
+     2. A backend
+     3. A destination name (equivalent to a table name for SQL backends)
+     4. Columns
+
+    In more detail:
+
+    ### Id Column Name
+
+    clearskies assumes that all models have a column that uniquely identifies each record.  This id column is
+    provided where appropriate in the lifecycle of the model save process to help connect and find related records.
+    It's defined as a simple class attribute called `id_column_name`.  There **MUST** be a column with the same name
+    in the column definitions.  A simple approach to take is to use the Uuid column as an id column.  This will
+    automatically provide a random UUID when the record is first created.  If you are using auto-incrementing integers,
+    you can simply use an `Int` column type and define the column as auto-incrementing in your database.
 
-try:
-    from typing_extensions import Self
-except ModuleNotFoundError:
+    ### Backend
+
+    Every model needs a backend, which is an object that extends clearskies.Backend and is attached to the
+    `backend` attribute of the model class.  clearskies comes with a variety of backends in the `clearskies.backends`
+    module that you can use, and you can also define your own or import more from additional packages.
+
+    ### Destination Name
+
+    The destination name is the equivalent of a table name in other frameworks, but the name is more generic to
+    reflect the fact that clearskies is intended to work with a variety of backends - not just SQL databases.
+    The exact meaning of the destination name depends on the backend: for a cursor backend it is in fact used
+    as the table name when fetching/storing records.  For the API backend it is frequently appended to a base
+    URL to reach the corect endpoint.
+
+    This is provided by a class function call `destination_name`.  The base model class declares a generic method
+    for this which takes the class name, converts it from title case to snake case, and makes it plural.  Hence,
+    a model class called `User` will have a default destination name of `users` and a model class of `OrderProduct`
+    will have a default destination name of `order_products`.  Of course, this system isn't pefect: your backend
+    may have a different convention or you may have one of the many words in the english language that are
+    exceptions to the grammatical rules of making words plural.  In this case you can simply extend the method
+    and change it according to your needs, e.g.:
+
+    ```
     from typing import Self
+    import clearskies
+
+    class Fish(clearskies.Model):
+        @classmethod
+        def destination_name(cls: type[Self]) -> str:
+            return "fish"
+    ```
+
+    ### Columns
+
+    Finally, columns are defined by attaching attributes to your model class that extend clearskies.Column.  A variety
+    are provided by default in the clearskies.columns module, and you can always create more or import them from
+    other packages.
+
+    ### Fetching From the Di Container
+
+    In order to use a model in your application you need to retrieve it from the dependency injection system.  Like
+    everything, you can do this by either the name or with type hinting.  Models do have a special rule for
+    injection-via-name: like all classes their dependency injection name is made by converting the class name from
+    title case to snake case, but they are also available via the pluralized name.  Here's a quick example of all
+    three approaches for dependency injection:
+
+    ```
+    import clearskies
 
+    class User(clearskies.Model):
+        id_column_name = "id"
+        backend = clearskies.backends.MemoryBackend()
 
-class Model(Models):
-    _configured_columns = None
-    _data = None
-    _previous_data = None
-    _touched_columns = None
-    _transformed = None
-    id_column_name = "id"
+        id = clearskies.columns.Uuid()
+        name = clearskies.columns.String()
 
-    def __init__(self: Self, backend, columns):
-        super().__init__(backend, columns)
-        self._transformed = {}
+    def my_application(user, users, by_type_hint: User):
+        return {
+            "all_are_user_models": isinstance(user, User) and isinstance(users, User) and isinstance(by_type_hint, User)
+        }
+
+    cli = clearskies.contexts.Cli(my_application, classes=[User])
+    cli()
+    ```
+
+    Note that the `User` model class was provided in the `classes` list sent to the context: that's important as it
+    informs the dependency injection system that this is a class we want to provide.  It's common (but not required)
+    to put all models for a clearskies application in their own separate python module and then provide those to
+    the depedency injection system via the `modules` argument to the context.  So you may have a directory structure
+    like this:
+
+    ```
+    ├── app/
+    │   └── models/
+    │       ├── __init__.py
+    │       ├── category.py
+    │       ├── order.py
+    │       ├── product.py
+    │       ├── status.py
+    │       └── user.py
+    └── api.py
+    ```
+
+    Where `__init__.py` imports all the models:
+
+    ```
+    from app.models.category import Category
+    from app.models.order import Order
+    from app.models.proudct import Product
+    from app.models.status import Status
+    from app.models.user import User
+
+    __all__ = ["Category", "Order", "Product", "Status", "User"]
+    ```
+
+    Then in your main application you can just import the whole `models` module into your context:
+
+    ```
+    import app.models
+
+    cli = clearskies.contexts.cli(SomeApplication, modules=[app.models])
+    ```
+
+    ### Adding Dependencies
+
+    The base model class extends `clearskies.di.InjectableProperties` which means that you can inject dependencies into your model
+    using the `di.inject` classes.  Here's an example that demonstrates dependency injection for models:
+
+    ```
+    import datetime
+    import clearskies
+
+    class SomeClass:
+        # Since this will be built by the DI system directly, we can declare dependencies in the __init__
+        def __init__(self, some_date):
+            self.some_date = some_date
+
+    class User(clearskies.Model):
+        id_column_name = "id"
+        backend = clearskies.backends.MemoryBackend()
+
+        utcnow = clearskies.di.inject.Utcnow()
+        some_class = clearskies.di.inject.ByClass(SomeClass)
+
+        id = clearskies.columns.Uuid()
+        name = clearskies.columns.String()
+
+        def some_date_in_the_past(self):
+            return self.some_class.some_date < self.utcnow
+
+    def my_application(user):
+        return user.some_date_in_the_past()
+
+    cli = clearskies.contexts.Cli(
+        my_application,
+        classes=[User],
+        bindings={
+            "some_date": datetime.datetime.now(datetime.timezone.utc) - datetime.timedelta(days=1),
+        }
+    )
+    cli()
+    ```
+    """
+
+    _previous_data: dict[str, Any] = {}
+    _data: dict[str, Any] = {}
+    _next_data: dict[str, Any] = {}
+    _transformed_data: dict[str, Any] = {}
+    _touched_columns: dict[str, bool] = {}
+    _query: Query | None = None
+    _query_executed: bool = False
+    _count: int | None = None
+    _next_page_data: dict[str, Any] | None = None
+
+    id_column_name: str = ""
+    backend: Backend = None  # type: ignore
+
+    _di = inject.Di()
+
+    def __init__(self):
+        if not self.id_column_name:
+            raise ValueError(
+                f"You must define the 'id_column_name' property for every model class, but this is missing for model '{self.__class__.__name__}'"
+            )
+        if not isinstance(self.id_column_name, str):
+            raise TypeError(
+                f"The 'id_column_name' property of a model must be a string that specifies the name of the id column, but that is not the case for model '{self.__class__.__name__}'."
+            )
+        if not self.backend:
+            raise ValueError(
+                f"You must define the 'backend' property for every model class, but this is missing for model '{self.__class__.__name__}'"
+            )
+        if not hasattr(self.backend, "documentation_pagination_parameters"):
+            raise TypeError(
+                f"The 'backend' property of a model must be an object that extends the clearskies.Backend class, but that is not the case for model '{self.__class__.__name__}'."
+            )
+        self._previous_data = {}
         self._data = {}
-        self._previous_data = None
-        self._touched_columns = None
+        self._next_data = {}
+        self._transformed_data = {}
+        self._touched_columns = {}
+        self._query = None
+        self._query_executed = False
+        self._count = None
+        self._next_page_data = None
 
-    def model_class(self: Self) -> type[Self]:
+    @classmethod
+    def destination_name(cls: type[Self]) -> str:
         """
-        Return the model class that this models object will find/return instances of
+        Return the name of the destination that the model uses for data storage.
 
-        This is needed by the models class
-        """
-        return self.__class__
+        For SQL backends, this would return the table name.  Other backends will use this
+        same function but interpret it in whatever way it makes sense.  For instance, an
+        API backend may treat it as a URL (or URL path), an SQS backend may expect a queue
+        URL, etc...
 
-    @classmethod
-    def table_name(cls: type[Self]) -> str:
-        """Return the name of the table that the model uses for data storage"""
+        By default this takes the class name, converts from title case to snake case, and then
+        makes it plural.
+        """
         singular = string.camel_case_to_snake_case(cls.__name__)
         if singular[-1] == "y":
             return singular[:-1] + "ies"
@@ -44,103 +243,67 @@ class Model(Models):
             return singular + "es"
         return f"{singular}s"
 
-    @abstractmethod
-    def columns_configuration(self: Self):
-        """Returns an ordered dictionary with the configuration for the columns"""
-        pass
-
-    def all_columns(self: Self):
-        default = OrderedDict([(self.id_column_name, {"class": UUID})])
-        default.update(self.columns_configuration())
-        return default
-
-    def columns(self: Self, overrides=None):
-        # no caching if we have overrides
-        if overrides is not None:
-            return self._columns.configure(self.all_columns(), self.__class__, overrides=overrides)
-
-        if self._configured_columns is None:
-            self._configured_columns = self._columns.configure(self.all_columns(), self.__class__)
-        return self._configured_columns
-
     def supports_n_plus_one(self: Self):
-        return self._backend.supports_n_plus_one
-
-    def __getitem__(self: Self, column_name):
-        return self.__getattr__(column_name)
-
-    def __getattr__(self: Self, column_name):
-        # this should be adjusted to only return None for empty records if the column name corresponds
-        # to an actual column in the table.
-        if not self.exists:
-            return None
-
-        return self.get_transformed_from_data(column_name, self._data)
-
-    def get(self: Self, column_name, silent=False):
-        if not self.exists:
-            return None
-
-        return self.get_transformed_from_data(column_name, self._data, silent=silent)
-
-    def get_transformed_from_data(self: Self, column_name, data, cache=True, check_providers=True, silent=False):
-        if cache and column_name in self._transformed:
-            return self._transformed[column_name]
-
-        # everything in self._data came directly out of the database, but we don't want to send that off.
-        # instead, the corresponding column has an opportunity to make changes as needed.  Moreover,
-        # it could be that the requested column_name doesn't even exist directly in self._data, but
-        # can be provided by a column.  Therefore, we're going to do some work to fulfill the request,
-        # raise an Error if we *really* can't fulfill it, and store the results in self._transformed
-        # as a simple local cache (self._transformed is cleared during a save operation)
-        columns = self.columns()
-        value = None
-        if (column_name not in data or data[column_name] is None) and check_providers:
-            for column in columns.values():
-                if column.can_provide(column_name):
-                    value = column.provide(data, column_name)
-                    break
-            if column_name not in data and value is None:
-                if not silent:
-                    raise KeyError(f"Unknown column '{column_name}' requested from model '{self.__class__.__name__}'")
-                return None
-        else:
-            value = (
-                self._backend.column_from_backend(self.columns()[column_name], data[column_name])
-                if column_name in self.columns()
-                else data[column_name]
-            )
+        return self.backend.supports_n_plus_one  #  type: ignore
 
-        if cache:
-            self._transformed[column_name] = value
-        return value
+    def __bool__(self: Self) -> bool:  # noqa: D105
+        if self._query:
+            return bool(self.__len__())
 
-    @property
-    def exists(self: Self) -> bool:
-        return True if (self.id_column_name in self._data and self._data[self.id_column_name]) else False
+        return True if self._data else False
 
-    @property
-    def data(self: Self):
+    def get_raw_data(self: Self) -> dict[str, Any]:
+        self.no_queries()
         return self._data
 
-    @data.setter
-    def data(self: Self, data) -> None:
+    def set_raw_data(self: Self, data: dict[str, Any]) -> None:
+        self.no_queries()
         self._data = {} if data is None else data
+        self._transformed_data = {}
 
-    def save(self: Self, data, columns=None) -> bool:
+    def save(self: Self, data: dict[str, Any] | None = None, columns: dict[str, Column] = {}, no_data=False) -> bool:
         """
-        Save data to the database and update the model!
+        Save data to the database and update the model.
+
+        Executes an update if the model corresponds to a record already, or an insert if not.
+
+        There are two supported flows.  One is to pass in a dictionary of data to save:
+
+        ```python
+        model.save({
+            "some_column": "New Value",
+            "another_column": 5,
+        })
+        ```
 
-        Executes an update if the model corresponds to a record already, or an insert if not
+        And the other is to set new values on the columns attributes and then call save without data:
+
+        ```python
+        model.some_column = "New Value"
+        model.another_column = 5
+        model.save()
+        ```
+
+        You cannot combine these methods.  If you set a value on a column attribute and also pass
+        in a dictionary of data to the save, then an exception will be raised.
         """
-        if not len(data):
-            raise ValueError("You have to pass in something to save!")
-        save_columns = self.columns()
+        self.no_queries()
+        if not data and not self._next_data and not no_data:
+            raise ValueError("You have to pass in something to save, or set no_data=True in your call to save/create.")
+        if data and self._next_data:
+            raise ValueError(
+                "Save data was provided to the model class by both passing in a dictionary and setting new values on the column attributes.  This is not allowed.  You will have to use just one method of specifying save data."
+            )
+        if not data:
+            data = {**self._next_data}
+            self._next_data = {}
+
+        save_columns = self.get_columns()
         if columns is not None:
             for column in columns.values():
                 save_columns[column.name] = column
 
-        old_data = self.data
+        old_data = self.get_raw_data()
         data = self.columns_pre_save(data, save_columns)
         data = self.pre_save(data)
         if data is None:
@@ -148,11 +311,11 @@ class Model(Models):
 
         [to_save, temporary_data] = self.columns_to_backend(data, save_columns)
         to_save = self.to_backend(to_save, save_columns)
-        if self.exists:
-            new_data = self._backend.update(self._data[self.id_column_name], to_save, self)
+        if self:
+            new_data = self.backend.update(self._data[self.id_column_name], to_save, self)  # type: ignore
         else:
-            new_data = self._backend.create(to_save, self)
-        id = self._backend.column_from_backend(save_columns[self.id_column_name], new_data[self.id_column_name])
+            new_data = self.backend.create(to_save, self)  # type: ignore
+        id = self.backend.column_from_backend(save_columns[self.id_column_name], new_data[self.id_column_name])  # type: ignore
 
         # if we had any temporary columns add them back in
         new_data = {
@@ -163,22 +326,23 @@ class Model(Models):
         data = self.columns_post_save(data, id, save_columns)
         self.post_save(data, id)
 
-        self.data = new_data
-        self._transformed = {}
+        self.set_raw_data(new_data)
+        self._transformed_data = {}
         self._previous_data = old_data
-        self._touched_columns = list(data.keys())
+        self._touched_columns = {key: True for key in data.keys()}
 
         self.columns_save_finished(save_columns)
         self.save_finished()
 
         return True
 
-    def is_changing(self: Self, key, data) -> bool:
+    def is_changing(self: Self, key: str, data: dict[str, Any]) -> bool:
         """
-        Returns True/False to denote if the given column is being modified by the active save operation
+        Return True/False to denote if the given column is being modified by the active save operation.
 
         Pass in the name of the column to check and the data dictionary from the save in progress
         """
+        self.no_queries()
         has_old_value = key in self._data
         has_new_value = key in data
 
@@ -187,24 +351,26 @@ class Model(Models):
         if not has_old_value:
             return True
 
-        return self.__getattr__(key) != data[key]
+        return getattr(self, key) != data[key]
 
-    def latest(self: Self, key, data):
+    def latest(self: Self, key: str, data: dict[str, Any]) -> Any:
         """
-        Returns the 'latest' value for a column during the save operation
+        Return the 'latest' value for a column during the save operation.
 
-        Returns either the column value from the data dictionary or the current value stored in the model
+        Return either the column value from the data dictionary or the current value stored in the model
         Basically, shorthand for the optimized version of:  `data.get(key, default=getattr(self, key))` (which is
         less than ideal because it always builds the default value, even when not necessary)
 
         Pass in the name of the column to check and the data dictionary from the save in progress
         """
+        self.no_queries()
         if key in data:
             return data[key]
-        return self.__getattr__(key)
+        return getattr(self, key)
 
-    def was_changed(self: Self, key) -> bool:
-        """Returns True/False to denote if a column was changed in the last save"""
+    def was_changed(self: Self, key: str) -> bool:
+        """Return True/False to denote if a column was changed in the last save."""
+        self.no_queries()
         if self._previous_data is None:
             raise ValueError("was_changed was called before a save was finished - you must save something first")
         if key not in self._touched_columns:
@@ -219,51 +385,56 @@ class Model(Models):
         if not has_old_value:
             return False
 
-        columns = self.columns()
-        new_value = self.__getattr__(key)
+        columns = self.get_columns()
+        new_value = self._data[key]
         old_value = self._previous_data[key]
         if key not in columns:
             return old_value != new_value
         return not columns[key].values_match(old_value, new_value)
 
-    def previous_value(self: Self, key):
-        return self.get_transformed_from_data(key, self._previous_data, cache=False, check_providers=False, silent=True)
+    def previous_value(self: Self, key: str):
+        """Return the value of a column from before the most recent save."""
+        self.no_queries()
+        return getattr(self.__class__, key).transform(self._previous_data.get(key))
 
     def delete(self: Self, except_if_not_exists=True) -> bool:
-        if not self.exists:
+        """Delete a record."""
+        self.no_queries()
+        if not self:
             if except_if_not_exists:
                 raise ValueError("Cannot delete model that already exists")
             return True
 
-        columns = self.columns()
+        columns = self.get_columns()
         self.columns_pre_delete(columns)
         self.pre_delete()
 
-        self._backend.delete(self._data[self.id_column_name], self)
+        self.backend.delete(self._data[self.id_column_name], self)  # type: ignore
 
         self.columns_post_delete(columns)
         self.post_delete()
         return True
 
-    def columns_pre_save(self: Self, data, columns):
-        """Uses the column information present in the model to make any necessary changes before saving"""
-        for column in columns.values():
-            data = column.pre_save(data, self)
-            if data is None:
-                raise ValueError(
-                    f"Column {column.name} of type {column.__class__.__name__} did not return any data for pre_save"
-                )
-        return data
-
-    def pre_save(self, data):
-        """
-        A hook to extend so you can provide additional pre-save logic as needed
-
-        It is passed in the data being saved and it should return the same data with adjustments as needed
-        """
+    def columns_pre_save(self: Self, data: dict[str, Any], columns) -> dict[str, Any]:
+        """Use the column information present in the model to make any necessary changes before saving."""
+        iterate = True
+        changed = {}
+        while iterate:
+            iterate = False
+            for column in columns.values():
+                data = column.pre_save(data, self)
+                if data is None:
+                    raise ValueError(
+                        f"Column {column.name} of type {column.__class__.__name__} did not return any data for pre_save"
+                    )
+
+                # if we have newly chnaged data then we want to loop through the pre-saves again
+                if data and column.name not in changed:
+                    changed[column.name] = True
+                    iterate = True
         return data
 
-    def columns_to_backend(self: Self, data, columns):
+    def columns_to_backend(self: Self, data: dict[str, Any], columns) -> Any:
         backend_data = {**data}
         temporary_data = {}
         for column in columns.values():
@@ -273,7 +444,7 @@ class Model(Models):
                     del backend_data[column.name]
                 continue
 
-            backend_data = self._backend.column_to_backend(column, backend_data)
+            backend_data = self.backend.column_to_backend(column, backend_data)  # type: ignore
             if backend_data is None:
                 raise ValueError(
                     f"Column {column.name} of type {column.__class__.__name__} did not return any data for to_database"
@@ -281,44 +452,40 @@ class Model(Models):
 
         return [backend_data, temporary_data]
 
-    def to_backend(self: Self, data, columns):
+    def to_backend(self: Self, data: dict[str, Any], columns) -> dict[str, Any]:
         return data
 
-    def columns_post_save(self: Self, data, id, columns):
-        """Uses the column information present in the model to make additional changes as needed after saving"""
+    def columns_post_save(self: Self, data: dict[str, Any], id: str | int, columns) -> dict[str, Any]:
+        """Use the column information present in the model to make additional changes as needed after saving."""
         for column in columns.values():
-            data = column.post_save(data, self, id)
-            if data is None:
-                raise ValueError(
-                    f"Column {column.name} of type {column.__class__.__name__} did not return any data for post_save"
-                )
+            column.post_save(data, self, id)
         return data
 
-    def columns_save_finished(self: Self, columns):
-        """Calls the save_finished method on all of our columns"""
+    def columns_save_finished(self: Self, columns) -> None:
+        """Call the save_finished method on all of our columns."""
         for column in columns.values():
             column.save_finished(self)
 
-    def post_save(self: Self, data, id):
+    def post_save(self: Self, data: dict[str, Any], id: str | int) -> None:
         """
-        A hook to extend so you can provide additional pre-save logic as needed
+        Create a hook to extend so you can provide additional pre-save logic as needed.
 
         It is passed in the data being saved as well as the id.  It should take action as needed and then return
         either the original data array or an adjusted one if appropriate.
         """
         pass
 
-    def pre_save(self: Self, data):
+    def pre_save(self: Self, data: dict[str, Any]) -> dict[str, Any]:
         """
-        A hook to extend so you can provide additional pre-save logic as needed
+        Create a hook to extend so you can provide additional pre-save logic as needed.
 
         It is passed in the data being saved and it should return the same data with adjustments as needed
         """
         return data
 
-    def save_finished(self: Self):
+    def save_finished(self: Self) -> None:
         """
-        A hook to extend so you can provide additional logic after a save operation has fully completed
+        Create a hook to extend so you can provide additional logic after a save operation has fully completed.
 
         It has no retrun value and is passed no data.  By the time this fires the model has already been
         updated with the new data.  You can decide on the necessary actions using the `was_changed` and
@@ -326,32 +493,666 @@ class Model(Models):
         """
         pass
 
-    def columns_pre_delete(self: Self, columns):
-        """Uses the column information present in the model to make any necessary changes before deleting"""
+    def columns_pre_delete(self: Self, columns: dict[str, Column]) -> None:
+        """Use the column information present in the model to make any necessary changes before deleting."""
         for column in columns.values():
             column.pre_delete(self)
 
-    def pre_delete(self: Self):
-        """
-        A hook to extend so you can provide additional pre-delete logic as needed
-        """
+    def pre_delete(self: Self) -> None:
+        """Create a hook to extend so you can provide additional pre-delete logic as needed."""
         pass
 
-    def columns_post_delete(self: Self, columns):
-        """Uses the column information present in the model to make any necessary changes after deleting"""
+    def columns_post_delete(self: Self, columns: dict[str, Column]) -> None:
+        """Use the column information present in the model to make any necessary changes after deleting."""
         for column in columns.values():
             column.post_delete(self)
 
-    def post_delete(self: Self):
+    def post_delete(self: Self) -> None:
+        """Create a hook to extend so you can provide additional post-delete logic as needed."""
+        pass
+
+    def where_for_request(
+        self: Self,
+        models: Self,
+        routing_data: dict[str, str],
+        authorization_data: dict[str, Any],
+        input_output: Any,
+        overrides: dict[str, Column] = {},
+    ) -> Self:
+        """Create a hook to automatically apply filtering whenever the model makes an appearance in a get/update/list/search handler."""
+        for column in self.get_columns(overrides=overrides).values():
+            models = column.where_for_request(models, routing_data, authorization_data, input_output)  # type: ignore
+        return models
+
+    ##############################################################
+    ### From here down is functionality related to list/search ###
+    ##############################################################
+    def has_query(self) -> bool:
+        """Whether or not this model instance represents a query."""
+        return bool(self._query)
+
+    def get_query(self) -> Query:
+        """Fetch the query object in the model."""
+        return self._query if self._query else Query(self.__class__)
+
+    def as_query(self) -> Self:
         """
-        A hook to extend so you can provide additional post-delete logic as needed
+        Make the model queryable.
+
+        This is used to remove the ambiguity of attempting execute a query against a model object that stores a record.
+
+        The reason this exists is because the model class is used both to query as well as to operate on single records, which can cause
+        subtle bugs if a developer accidentally confuses the two usages.  Consider the following (partial) example:
+
+        ```python
+        def some_function(models):
+            model = models.find("id=5")
+            if model:
+                models.save({"test": "example"})
+            other_record = model.find("id=6")
+        ```
+
+        In the above example it seems likely that the intention was to use `model.save()`, not `models.save()`.  Similarly, the last line
+        should be `models.find()`, not `model.find()`.  To minimize these kinds of issues, clearskies won't let you execute a query against
+        an individual model record, nor will it let you execute a save against a model being used to make a query.  In both cases, you'll
+        get an exception from clearskies, as the models track exactly how they are being used.
+
+        In some rare cases though, you may want to start a new query aginst a model that represents a single record.  This is most common
+        if you have a function that was passed an individual model, and you'd like to use it to fetch more records without having to
+        inject the model class more generally.  That's where the `as_query()` method comes in.  It's basically just a way of telling clearskies
+        "yes, I really do want to start a query using a model that represents a record".  So, for example:
+
+        ```python
+        def some_function(models):
+            model = models.find("id=5")
+            more_models = model.where("test=example")  # throws an exception.
+            more_models = model.as_query().where("test=example")  # works as expected.
+        ```
         """
-        pass
+        new_model = self._di.build(self.__class__, cache=False)
+        new_model.set_query(Query(self.__class__))
+        return new_model
+
+    def set_query(self, query: Query) -> Self:
+        """Set the query object."""
+        self._query = query
+        self._query_executed = False
+        return self
 
-    def where_for_request(self: Self, models, routing_data, authorization_data, input_output, overrides=None):
+    def with_query(self, query: Query) -> Self:
+        return self._di.build(self.__class__, cache=False).set_query(query)
+
+    def select(self: Self, select: str) -> Self:
         """
-        A hook to automatically apply filtering whenever the model makes an appearance in a get/update/list/search handler.
+        Add some additional columns to the select part of the query.
+
+        This method returns a new object with the updated query.  The original model object is unmodified.
+        Multiple calls to this method add together.  The following:
+
+        ```python
+        models.select("column_1 column_2").select("column_3")
+        ```
+
+        will select column_1, column_2, column_3 in the final query.
         """
-        for column in self.columns(overrides=overrides).values():
-            models = column.where_for_request(models, routing_data, authorization_data, input_output)
-        return models
+        self.no_single_model()
+        return self.with_query(self.get_query().add_select(select))
+
+    def select_all(self: Self, select_all=True) -> Self:
+        """
+        Set whether or not to select all columns with the query.
+
+        This method returns a new object with the updated query.  The original model object is unmodified.
+        """
+        self.no_single_model()
+        return self.with_query(self.get_query().set_select_all(select_all))
+
+    def where(self: Self, where: str | Condition) -> Self:
+        """
+        Add a condition to a query.
+
+        The `where` method (in combination with the `find` method) is typically the starting point for query records in
+        a model.  You don't *have* to add a condition to a model in order to fetch records, but of course it's a very
+        common use case.  Conditions in clearskies can be built from the columns or can be constructed as SQL-like
+        string conditions, e.g. `model.where("name=Bob")` or `model.where(model.name.equals("Bob"))`.  The latter
+        provides strict type-checking, while the former does not.  Either way they have the same result.  The list of
+        supported operators for a given column can be seen by checking the `_allowed_search_operators` attribute of the
+        column class.  Most columns accept all allowed operators, which are:
+
+         - "<=>"
+         - "!="
+         - "<="
+         - ">="
+         - ">"
+         - "<"
+         - "="
+         - "in"
+         - "is not null"
+         - "is null"
+         - "like"
+
+        When working with string conditions, it is safe to inject user input into the condition.  The allowed
+        format for conditions is very simple: `f"{column_name}\\s?{operator}\\s?{value}"`.  This makes it possible to
+        unambiguously separate all three pieces from eachother.  It's not possible to inject malicious payloads into either
+        the column names or operators because both are checked against a strict allow list (e.g. the columns declared in the
+        model or the list of allowed operators above).  The value is then extracted from the leftovers, and this is
+        provided to the backend separately so it can use it appropriately (e.g. using prepared statements for the cursor
+        backend).  Of course, you generally shouldn't have to inject user input into conditions very often because, most
+        often, the various list/search endpoints do this for you, but if you have to do it there are no security
+        concerns.
+
+        You can include a table name before the column name, with the two separated by a period.  As always, if you do this,
+        ensure that you include a supporting join statement (via the `join` method - see it for examples).
+
+        When you call the `where` method it returns a new model object with it's query configured to include the additional
+        condition.  The original model object remains unchanged.  Multiple conditions are always joined with AND.  There is
+        no explicit option for OR.  The closest is using an IN condition.
+
+        To access the results you have to iterate over the resulting model.  If you are only expecting one result
+        and want to work directly with it, then you can use `model.find(condition)` or `model.where(condition).first()`.
+
+        Example:
+        ```python
+        import clearskies
+
+        class Order(clearskies.Model):
+            id_column_name = "id"
+            backend = clearskies.backends.MemoryBackend()
+
+            id = clearskies.columns.Uuid()
+            user_id = clearskies.columns.String()
+            status = clearskies.columns.Select(["Pending", "In Progress"])
+            total = clearskies.columns.Float()
+
+        def my_application(orders):
+            orders.create({"user_id": "Bob", "status": "Pending", "total": 25})
+            orders.create({"user_id": "Alice", "status": "In Progress", "total": 15})
+            orders.create({"user_id": "Jane", "status": "Pending", "total": 30})
+
+            return [order.user_id for order in orders.where("status=Pending").where(Order.total.greater_than(25))]
+
+        cli = clearskies.contexts.Cli(
+            my_application,
+            classes=[Order],
+        )
+        cli()
+        ```
+
+        Which, if ran, returns: `["Jane"]`
+
+        """
+        self.no_single_model()
+        return self.with_query(self.get_query().add_where(where if isinstance(where, Condition) else Condition(where)))
+
+    def join(self: Self, join: str) -> Self:
+        """
+        Add a join clause to the query.
+
+        As with the `where` method, this expects a string which is parsed accordingly.  The syntax is not as flexible as
+        SQL and expects a format of:
+
+        ```
+        [left|right|inner]? join [right_table_name] ON [right_table_name].[right_column_name]=[left_table_name].[left_column_name].
+        ```
+
+        This is case insensitive.  Aliases are allowed.  If you don't specify a join type it defaults to inner.
+        Here are two examples of valid join statements:
+
+         - `join orders on orders.user_id=users.id`
+         - `left join user_orders as orders on orders.id=users.id`
+
+        Note that joins are not strictly limited to SQL-like backends, but of course no all backends will support joining.
+
+        A basic example:
+
+        ```
+        import clearskies
+
+        class User(clearskies.Model):
+            id_column_name = "id"
+            backend = clearskies.backends.MemoryBackend()
+
+            id = clearskies.columns.Uuid()
+            name = clearskies.columns.String()
+
+        class Order(clearskies.Model):
+            id_column_name = "id"
+            backend = clearskies.backends.MemoryBackend()
+
+            id = clearskies.columns.Uuid()
+            user_id = clearskies.columns.BelongsToId(User, readable_parent_columns=["id", "name"])
+            user = clearskies.columns.BelongsToModel("user_id")
+            status = clearskies.columns.Select(["Pending", "In Progress"])
+            total = clearskies.columns.Float()
+
+        def my_application(users, orders):
+            jane = users.create({"name": "Jane"})
+            another_jane = users.create({"name": "Jane"})
+            bob = users.create({"name": "Bob"})
+
+            # Jane's orders
+            orders.create({"user_id": jane.id, "status": "Pending", "total": 25})
+            orders.create({"user_id": jane.id, "status": "Pending", "total": 30})
+            orders.create({"user_id": jane.id, "status": "In Progress", "total": 35})
+
+            # Another Jane's orders
+            orders.create({"user_id": another_jane.id, "status": "Pending", "total": 15})
+
+            # Bob's orders
+            orders.create({"user_id": bob.id, "status": "Pending", "total": 28})
+            orders.create({"user_id": bob.id, "status": "In Progress", "total": 35})
+
+            # return all orders for anyone named Jane that have a status of Pending
+            return orders.join("join users on users.id=orders.user_id").where("users.name=Jane").sort_by("total", "asc").where("status=Pending")
+
+        cli = clearskies.contexts.Cli(
+            clearskies.endpoints.Callable(
+                my_application,
+                model_class=Order,
+                readable_column_names=["user", "total"],
+            ),
+            classes=[Order, User],
+        )
+        cli()
+
+        ```
+        """
+        self.no_single_model()
+        return self.with_query(self.get_query().add_join(Join(join)))
+
+    def is_joined(self: Self, table_name: str, alias: str = "") -> bool:
+        """
+        Check if a given table was already joined.
+
+        If you provide an alias then it will also verify if the table was joined with the specific alias name.
+        """
+        for join in self.get_query().joins:
+            if join.unaliased_table_name != table_name:
+                continue
+
+            if alias and join.alias != alias:
+                continue
+
+            return True
+        return False
+
+    def group_by(self: Self, group_by_column_name: str) -> Self:
+        """Add a group by clause to the query."""
+        self.no_single_model()
+        return self.with_query(self.get_query().set_group_by(group_by_column_name))
+
+    def sort_by(
+        self: Self,
+        primary_column_name: str,
+        primary_direction: str,
+        primary_table_name: str = "",
+        secondary_column_name: str = "",
+        secondary_direction: str = "",
+        secondary_table_name: str = "",
+    ) -> Self:
+        """
+        Add a sort by clause to the query.  You can sort by up to two columns at once.
+
+        Example:
+        ```
+        import clearskies
+
+        class Order(clearskies.Model):
+            id_column_name = "id"
+            backend = clearskies.backends.MemoryBackend()
+
+            id = clearskies.columns.Uuid()
+            user_id = clearskies.columns.String()
+            status = clearskies.columns.Select(["Pending", "In Progress"])
+            total = clearskies.columns.Float()
+
+        def my_application(orders):
+            orders.create({"user_id": "Bob", "status": "Pending", "total": 25})
+            orders.create({"user_id": "Alice", "status": "In Progress", "total": 15})
+            orders.create({"user_id": "Alice", "status": "Pending", "total": 30})
+            orders.create({"user_id": "Bob", "status": "Pending", "total": 26})
+
+            return orders.sort_by("user_id", "asc", secondary_column_name="total", secondary_direction="desc")
+
+        cli = clearskies.contexts.Cli(
+            clearskies.endpoints.Callable(
+                my_application,
+                model_class=Order,
+                readable_column_names=["user_id", "total"],
+            ),
+            classes=[Order],
+        )
+        cli()
+        ```
+        """
+        self.no_single_model()
+        sort = Sort(primary_table_name, primary_column_name, primary_direction)
+        secondary_sort = None
+        if secondary_column_name and secondary_direction:
+            secondary_sort = Sort(secondary_table_name, secondary_column_name, secondary_direction)
+        return self.with_query(self.get_query().set_sort(sort, secondary_sort))
+
+    def limit(self: Self, limit: int) -> Self:
+        """
+        Set the number of records to return.
+
+        ```
+        import clearskies
+
+        class Order(clearskies.Model):
+            id_column_name = "id"
+            backend = clearskies.backends.MemoryBackend()
+
+            id = clearskies.columns.Uuid()
+            user_id = clearskies.columns.String()
+            status = clearskies.columns.Select(["Pending", "In Progress"])
+            total = clearskies.columns.Float()
+
+        def my_application(orders):
+            orders.create({"user_id": "Bob", "status": "Pending", "total": 25})
+            orders.create({"user_id": "Alice", "status": "In Progress", "total": 15})
+            orders.create({"user_id": "Alice", "status": "Pending", "total": 30})
+            orders.create({"user_id": "Bob", "status": "Pending", "total": 26})
+
+            return orders.limit(2)
+
+        cli = clearskies.contexts.Cli(
+            clearskies.endpoints.Callable(
+                my_application,
+                model_class=Order,
+                readable_column_names=["user_id", "total"],
+            ),
+            classes=[Order],
+        )
+        cli()
+        ```
+        """
+        self.no_single_model()
+        return self.with_query(self.get_query().set_limit(limit))
+
+    def pagination(self: Self, **pagination_data) -> Self:
+        """
+        Set the pagination parameter(s) for the query.
+
+        The exact details of how pagination work depend on the backend.  For instance, the cursor and memory backend
+        expect to be given a `start` parameter, while an API backend will vary with the API, and the dynamodb backend
+        expects a kwarg called `cursor`.  As a result, it's necessary to check the backend documentation to understand
+        how to properly set pagination.  The endpoints automatically account for this because backends are required
+        to declare pagination details via the `allowed_pagination_keys` method.  If you attempt to set invalid
+        pagination data via this method, clearskies will raise a ValueError.
+
+        Example:
+        ```
+        import clearskies
+
+        class Order(clearskies.Model):
+            id_column_name = "id"
+            backend = clearskies.backends.MemoryBackend()
+
+            id = clearskies.columns.Uuid()
+            user_id = clearskies.columns.String()
+            status = clearskies.columns.Select(["Pending", "In Progress"])
+            total = clearskies.columns.Float()
+
+        def my_application(orders):
+            orders.create({"user_id": "Bob", "status": "Pending", "total": 25})
+            orders.create({"user_id": "Alice", "status": "In Progress", "total": 15})
+            orders.create({"user_id": "Alice", "status": "Pending", "total": 30})
+            orders.create({"user_id": "Bob", "status": "Pending", "total": 26})
+
+            return orders.sort_by("total", "asc").pagination(start=2)
+
+        cli = clearskies.contexts.Cli(
+            clearskies.endpoints.Callable(
+                my_application,
+                model_class=Order,
+                readable_column_names=["user_id", "total"],
+            ),
+            classes=[Order],
+        )
+        cli()
+        ```
+
+        However, if the return line in `my_application` is switched for either of these:
+
+        ```
+        return orders.sort_by("total", "asc").pagination(start="asdf")
+        return orders.sort_by("total", "asc").pagination(something_else=5)
+        ```
+
+        Will result in an exception that explains exactly what is wrong.
+
+        """
+        self.no_single_model()
+        error = self.backend.validate_pagination_data(pagination_data, str)
+        if error:
+            raise ValueError(
+                f"Invalid pagination data for model {self.__class__.__name__} with backend "
+                + f"{self.backend.__class__.__name__}. {error}"
+            )
+        return self.with_query(self.get_query().set_pagination(pagination_data))
+
+    def find(self: Self, where: str | Condition) -> Self:
+        """
+        Return the first model matching a given where condition.
+
+        This is just shorthand for `models.where("column=value").find()`.  Example:
+
+        ```python
+        import clearskies
+
+        class Order(clearskies.Model):
+            id_column_name = "id"
+            backend = clearskies.backends.MemoryBackend()
+
+            id = clearskies.columns.Uuid()
+            user_id = clearskies.columns.String()
+            status = clearskies.columns.Select(["Pending", "In Progress"])
+            total = clearskies.columns.Float()
+
+        def my_application(orders):
+            orders.create({"user_id": "Bob", "status": "Pending", "total": 25})
+            orders.create({"user_id": "Alice", "status": "In Progress", "total": 15})
+            orders.create({"user_id": "Jane", "status": "Pending", "total": 30})
+
+            jane = orders.find("user_id=Jane")
+            jane.total = 35
+            jane.save()
+
+            return {
+                "user_id": jane.user_id,
+                "total": jane.total,
+            }
+
+        cli = clearskies.contexts.Cli(
+            my_application,
+            classes=[Order],
+        )
+        cli()
+        ```
+        """
+        self.no_single_model()
+        return self.where(where).first()
+
+    def __len__(self: Self):  # noqa: D105
+        self.no_single_model()
+        if self._count is None:
+            self._count = self.backend.count(self.get_query())
+        return self._count
+
+    def __iter__(self: Self) -> Iterator[Self]:  # noqa: D105
+        self.no_single_model()
+        self._next_page_data = {}
+        raw_rows = self.backend.records(
+            self.get_query(),
+            next_page_data=self._next_page_data,
+        )
+        return iter([self.model(row) for row in raw_rows])
+
+    def paginate_all(self: Self) -> list[Self]:
+        """
+        Loop through all available pages of results and returns a list of all models that match the query.
+
+        If you don't set a limit on a query, some backends will return all records but some backends have a
+        default maximum number of results that they will return.  In the latter case, you can use `paginate_all`
+        to fetch all records by instructing clearskies to iterate over all pages.  This is possible because backends
+        are required to define how pagination works in a way that clearskies can automatically understand and
+        use.  To demonstrate this, the following example sets a limit of 1 which stops the memory backend
+        from returning everything, and then uses `paginate_all` to fetch all records.  The memory backend
+        doesn't have a default limit, so in practice the `paginate_all` is unnecessary here, but this is done
+        for demonstration purposes.
+
+        ```
+        import clearskies
+
+        class Order(clearskies.Model):
+            id_column_name = "id"
+            backend = clearskies.backends.MemoryBackend()
+
+            id = clearskies.columns.Uuid()
+            user_id = clearskies.columns.String()
+            status = clearskies.columns.Select(["Pending", "In Progress"])
+            total = clearskies.columns.Float()
+
+        def my_application(orders):
+            orders.create({"user_id": "Bob", "status": "Pending", "total": 25})
+            orders.create({"user_id": "Alice", "status": "In Progress", "total": 15})
+            orders.create({"user_id": "Alice", "status": "Pending", "total": 30})
+            orders.create({"user_id": "Bob", "status": "Pending", "total": 26})
+
+            return orders.limit(1).paginate_all()
+
+        cli = clearskies.contexts.Cli(
+            clearskies.endpoints.Callable(
+                my_application,
+                model_class=Order,
+                readable_column_names=["user_id", "total"],
+            ),
+            classes=[Order],
+        )
+        cli()
+        ```
+
+        NOTE: this loads up all records in memory before returning (e.g. it isn't using generators yet), so
+        expect delays for large record sets.
+        """
+        self.no_single_model()
+        next_models = self.with_query(self.get_query())
+        results = list(next_models.__iter__())
+        next_page_data = next_models.next_page_data()
+        while next_page_data:
+            next_models = self.pagination(**next_page_data)
+            results.extend(next_models.__iter__())
+            next_page_data = next_models.next_page_data()
+        return results
+
+    def model(self: Self, data: dict[str, Any] = {}) -> Self:
+        """
+        Create a new model object and populates it with the data in `data`.
+
+        NOTE: the difference between this and `model.create` is that model.create() actually saves a record in the backend,
+        while this method just creates a model object populated with the given data.
+        """
+        model = self._di.build(self.__class__, cache=False)
+        model.set_raw_data(data)
+        return model
+
+    def empty(self: Self) -> Self:
+        """
+        An alias for self.model({})
+        """
+        return self.model({})
+
+    def create(self: Self, data: dict[str, Any] = {}, columns: dict[str, Column] = {}, no_data=False) -> Self:
+        """
+        Create a new record in the backend using the information in `data`.
+
+        new_model = models.create({"column": "value"})
+        """
+        empty = self.model()
+        empty.save(data, columns=columns, no_data=no_data)
+        return empty
+
+    def first(self: Self) -> Self:
+        """
+        Return the first model for a given query.
+
+        The `where` method returns an object meant to be iterated over.  If you are expecting your query to return a single
+        record, then you can use first to turn that directly into the matching model so you don't have to iterate over it:
+
+        ```
+        import clearskies
+
+        class Order(clearskies.Model):
+            id_column_name = "id"
+            backend = clearskies.backends.MemoryBackend()
+
+            id = clearskies.columns.Uuid()
+            user_id = clearskies.columns.String()
+            status = clearskies.columns.Select(["Pending", "In Progress"])
+            total = clearskies.columns.Float()
+
+        def my_application(orders):
+            orders.create({"user_id": "Bob", "status": "Pending", "total": 25})
+            orders.create({"user_id": "Alice", "status": "In Progress", "total": 15})
+            orders.create({"user_id": "Jane", "status": "Pending", "total": 30})
+
+            jane = orders.where("status=Pending").where(Order.total.greater_than(25)).first()
+            jane.total = 35
+            jane.save()
+
+            return {
+                "user_id": jane.user_id,
+                "total": jane.total,
+            }
+
+        cli = clearskies.contexts.Cli(
+            my_application,
+            classes=[Order],
+        )
+        cli()
+
+        ```
+        """
+        self.no_single_model()
+        iter = self.__iter__()
+        try:
+            return iter.__next__()
+        except StopIteration:
+            return self.model()
+
+    def allowed_pagination_keys(self: Self) -> list[str]:
+        return self.backend.allowed_pagination_keys()
+
+    def validate_pagination_data(self, kwargs: dict[str, Any], case_mapping: Callable[[str], str]) -> str:
+        return self.backend.validate_pagination_data(kwargs, case_mapping)
+
+    def next_page_data(self: Self):
+        return self._next_page_data
+
+    def documentation_pagination_next_page_response(self: Self, case_mapping: Callable) -> list[Any]:
+        return self.backend.documentation_pagination_next_page_response(case_mapping)
+
+    def documentation_pagination_next_page_example(self: Self, case_mapping: Callable) -> dict[str, Any]:
+        return self.backend.documentation_pagination_next_page_example(case_mapping)
+
+    def documentation_pagination_parameters(self: Self, case_mapping: Callable) -> list[tuple[AutoDocSchema, str]]:
+        return self.backend.documentation_pagination_parameters(case_mapping)
+
+    def no_queries(self) -> None:
+        if self._query:
+            raise ValueError(
+                "You attempted to save/read record data for a model being used to make a query.  This is not allowed, as it is typically a sign of a bug in your application code."
+            )
+
+    def no_single_model(self):
+        if self._data:
+            raise ValueError(
+                "You have attempted to execute a query against a model that represents an individual record.  This is not allowed, as it is typically a sign of a bug in your application code.  If this is intentional, call model.as_query() before executing your query."
+            )
+
+
+class ModelClassReference:
+    @abstractmethod
+    def get_model_class(self) -> type[Model]:
+        pass