add indexes info to the docs

Signed-off-by: Grant Ramsay <seapagan@gmail.com>

Author: seapagan

README.md

@@ -47,6 +47,8 @@ Website](https://sqliter.grantramsay.dev)
 ## Features
 
 - Table creation based on Pydantic models
+- Automatic primary key generation
+- User defined indexes on any field
 - CRUD operations (Create, Read, Update, Delete)
 - Chained Query building with filtering, ordering, and pagination
 - Transaction support
@@ -70,16 +72,16 @@ virtual environments (`uv` is used for developing this project and in the CI):
 uv add sqliter-py
 ```
 
-With `pip`:
+With `Poetry`:
 
 ```bash
-pip install sqliter-py
+poetry add sqliter-py
 ```
 
-Or with `Poetry`:
+Or with `pip`:
 
 ```bash
-poetry add sqliter-py
+pip install sqliter-py
 ```
 
 ### Optional Dependencies
@@ -88,9 +90,9 @@ Currently by default, the only external dependency is Pydantic. However, there
 are some optional dependencies that can be installed to enable additional
 features:
 
-- `inflect`: For pluralizing table names (if not specified). This just offers a
-  more-advanced pluralization than the default method used. In most cases you
-  will not need this.
+- `inflect`: For pluralizing the auto-generated table names (if not explicitly
+  set in the Model) This just offers a more-advanced pluralization than the
+  default method used. In most cases you will not need this.
 
 See [Installing Optional
 Dependencies](https://sqliter.grantramsay.dev/installation#optional-dependencies)

TODO.md

@@ -12,7 +12,6 @@
   addition to the `delete` method in the main class which deletes a single
   record based on the primary key.
 - add a `rollback` method to the main class to allow manual rollbacks.
-- allow adding multiple indexes to each table as well as the primary key.
 - allow adding foreign keys and relationships to each table.
 - add a migration system to allow updating the database schema without losing
   data.

docs/guide/exceptions.md

@@ -10,51 +10,55 @@ class, `SqliterError`, to ensure consistency across error messages and behavior.
   - **Message**: "An error occurred in the SQLiter package."
 
 - **`DatabaseConnectionError`**:
-  - Raised when the SQLite database connection fails.
+  - **Raised** when the SQLite database connection fails.
   - **Message**: "Failed to connect to the database: '{}'."
 
 - **`InvalidOffsetError`**:
-  - Raised when an invalid offset value (0 or negative) is used in queries.
+  - **Raised** when an invalid offset value (0 or negative) is used in queries.
   - **Message**: "Invalid offset value: '{}'. Offset must be a positive
     integer."
 
 - **`InvalidOrderError`**:
-  - Raised when an invalid order value is used in queries, such as a
+  - **Raised** when an invalid order value is used in queries, such as a
     non-existent field or an incorrect sorting direction.
   - **Message**: "Invalid order value - '{}'"
 
 - **`TableCreationError`**:
-  - Raised when a table cannot be created in the database.
+  - **Raised** when a table cannot be created in the database.
   - **Message**: "Failed to create the table: '{}'."
 
 - **`RecordInsertionError`**:
-  - Raised when an error occurs during record insertion.
+  - **Raised** when an error occurs during record insertion.
   - **Message**: "Failed to insert record into table: '{}'."
 
 - **`RecordUpdateError`**:
-  - Raised when an error occurs during record update.
+  - **Raised** when an error occurs during record update.
   - **Message**: "Failed to update record in table: '{}'."
 
 - **`RecordNotFoundError`**:
-  - Raised when a record with the specified primary key is not found.
+  - **Raised** when a record with the specified primary key is not found.
   - **Message**: "Failed to find a record for key '{}'".
 
 - **`RecordFetchError`**:
-  - Raised when an error occurs while fetching records from the database.
+  - **Raised** when an error occurs while fetching records from the database.
   - **Message**: "Failed to fetch record from table: '{}'."
 
 - **`RecordDeletionError`**:
-  - Raised when an error occurs during record deletion.
+  - **Raised** when an error occurs during record deletion.
   - **Message**: "Failed to delete record from table: '{}'."
 
 - **`InvalidFilterError`**:
-  - Raised when an invalid filter field is used in a query.
+  - **Raised** when an invalid filter field is used in a query.
   - **Message**: "Failed to apply filter: invalid field '{}'".
 
 - **`TableDeletionError`**:
-  - Raised when a table cannot be deleted from the database.
+  - **Raised** when a table cannot be deleted from the database.
   - **Message**: "Failed to delete the table: '{}'."
 
 - **SqlExecutionError**
-  - Raised when an error occurs during SQL query execution.
+  - **Raised** when an error occurs during SQL query execution.
   - **Message**: "Failed to execute SQL: '{}'."
+
+- **InvalidIndexError**
+  - **Raised** when an invalid index is specified for a model.
+  - **Message**: "Invalid fields for indexing in model '{}': {}"

docs/guide/models.md

@@ -29,6 +29,53 @@ the table.
 > - The Model **automatically** creates an **auto-incrementing integer primary
 > key** for each table called `pk`, you do not need to define it yourself.
 
+### Adding Indexes
+
+You can add indexes to your table by specifying the `indexes` attribute in the
+`Meta` class. This should be a list of strings, each string being the name of an
+existing field in the model that should be indexed.
+
+```python
+from sqliter.model import BaseDBModel
+
+class User(BaseDBModel):
+    name: str
+    age: int
+    email: str
+
+    class Meta:
+        indexes = ["name", "email"]
+```
+
+This is in addition to the primary key index (`pk`) that is automatically
+created.
+
+### Adding Unique Indexes
+
+You can add unique indexes to your table by specifying the `unique_indexes`
+attribute in the `Meta` class. This should be a list of strings, each string
+being the name of an existing field in the model that should be indexed.
+
+```python
+from sqliter.model import BaseDBModel
+
+class User(BaseDBModel):
+    name: str
+    age: int
+    email: str
+
+    class Meta:
+        unique_indexes = ["email"]
+```
+
+These will ensure that all values in this field are unique. This is in addition
+to the primary key index (`pk`) that is automatically created.
+
+> [!TIP]
+>
+> You can specify both `indexes` and `unique_indexes` in the `Meta` class if you
+> need to.
+
 ### Custom Table Name
 
 By default, the table name will be the same as the model name, converted to

docs/index.md

@@ -38,6 +38,8 @@ database-like format without needing to learn SQL or use a full ORM.
 ## Features
 
 - Table creation based on Pydantic models
+- Automatic primary key generation
+- User defined indexes on any field
 - CRUD operations (Create, Read, Update, Delete)
 - Chained Query building with filtering, ordering, and pagination
 - Transaction support

docs/installation.md

@@ -10,16 +10,16 @@ virtual environments (`uv` is used for developing this project and in the CI):
 uv add sqliter-py
 ```
 
-With `pip`:
+With `Poetry`:
 
 ```bash
-pip install sqliter-py
+poetry add sqliter-py
 ```
 
-Or with `Poetry`:
+Or with `pip`:
 
 ```bash
-poetry add sqliter-py
+pip install sqliter-py
 ```
 
 ## Optional Dependencies
@@ -38,14 +38,14 @@ These can be installed using `uv`:
 uv add 'sqliter-py[extras]'
 ```
 
-Or with `pip`:
+With `Poetry`:
 
 ```bash
-pip install 'sqliter-py[extras]'
+poetry add 'sqliter-py[extras]'
 ```
 
-Or with `Poetry`:
+Or with `pip`:
 
 ```bash
-poetry add 'sqliter-py[extras]'
+pip install 'sqliter-py[extras]'
 ```

docs/quickstart.md

@@ -14,10 +14,6 @@ class User(BaseDBModel):
     age: int
     admin: Optional[bool] = False
 
-    class Meta:
-        create_pk = False
-        primary_key = "name"
-
 # Create a database connection
 db = SqliterDB("example.db")