Initial commit

docs/api/alembic/create-materialized-view-op.md

@@ -0,0 +1,13 @@
+# `CreateMaterializedViewOp` class
+
+Alembic operation to create a materialized view.
+
+```python
+from sqlalchemy_pgview.alembic import CreateMaterializedViewOp
+```
+
+::: sqlalchemy_pgview.alembic.CreateMaterializedViewOp
+    options:
+        members:
+            - create_materialized_view
+            - reverse

docs/api/alembic/create-view-op.md

@@ -0,0 +1,14 @@
+# `CreateViewOp` class
+
+Alembic operation to create a view.
+
+```python
+import sqlalchemy_pgview.alembic  # Registers operations
+from sqlalchemy_pgview.alembic import CreateViewOp
+```
+
+::: sqlalchemy_pgview.alembic.CreateViewOp
+    options:
+        members:
+            - create_view
+            - reverse

docs/api/alembic/drop-materialized-view-op.md

@@ -0,0 +1,12 @@
+# `DropMaterializedViewOp` class
+
+Alembic operation to drop a materialized view.
+
+```python
+from sqlalchemy_pgview.alembic import DropMaterializedViewOp
+```
+
+::: sqlalchemy_pgview.alembic.DropMaterializedViewOp
+    options:
+        members:
+            - drop_materialized_view

docs/api/alembic/drop-view-op.md

@@ -0,0 +1,12 @@
+# `DropViewOp` class
+
+Alembic operation to drop a view.
+
+```python
+from sqlalchemy_pgview.alembic import DropViewOp
+```
+
+::: sqlalchemy_pgview.alembic.DropViewOp
+    options:
+        members:
+            - drop_view

docs/api/alembic/refresh-materialized-view-op.md

@@ -0,0 +1,12 @@
+# `RefreshMaterializedViewOp` class
+
+Alembic operation to refresh a materialized view.
+
+```python
+from sqlalchemy_pgview.alembic import RefreshMaterializedViewOp
+```
+
+::: sqlalchemy_pgview.alembic.RefreshMaterializedViewOp
+    options:
+        members:
+            - refresh_materialized_view

docs/api/ddl/create-materialized-view.md

@@ -0,0 +1,9 @@
+# `CreateMaterializedView` class
+
+DDL element to create a PostgreSQL materialized view.
+
+```python
+from sqlalchemy_pgview import CreateMaterializedView
+```
+
+::: sqlalchemy_pgview.CreateMaterializedView

docs/api/ddl/create-view.md

@@ -0,0 +1,9 @@
+# `CreateView` class
+
+DDL element to create a PostgreSQL view.
+
+```python
+from sqlalchemy_pgview import CreateView
+```
+
+::: sqlalchemy_pgview.CreateView

docs/api/ddl/drop-materialized-view.md

@@ -0,0 +1,12 @@
+# `DropMaterializedView` class
+
+DDL element to drop a PostgreSQL materialized view.
+
+```python
+from sqlalchemy_pgview import DropMaterializedView
+```
+
+::: sqlalchemy_pgview.DropMaterializedView
+    options:
+        members:
+            - fullname

docs/api/ddl/drop-view.md

@@ -0,0 +1,12 @@
+# `DropView` class
+
+DDL element to drop a PostgreSQL view.
+
+```python
+from sqlalchemy_pgview import DropView
+```
+
+::: sqlalchemy_pgview.DropView
+    options:
+        members:
+            - fullname

docs/api/ddl/refresh-materialized-view.md

@@ -0,0 +1,12 @@
+# `RefreshMaterializedView` class
+
+DDL element to refresh a PostgreSQL materialized view.
+
+```python
+from sqlalchemy_pgview import RefreshMaterializedView
+```
+
+::: sqlalchemy_pgview.RefreshMaterializedView
+    options:
+        members:
+            - fullname

docs/api/dependencies/get-all-views.md

@@ -0,0 +1,7 @@
+# `get_all_views`
+
+```python
+from sqlalchemy_pgview import get_all_views
+```
+
+::: sqlalchemy_pgview.get_all_views

docs/api/dependencies/get-dependency-order.md

@@ -0,0 +1,7 @@
+# `get_dependency_order`
+
+```python
+from sqlalchemy_pgview import get_dependency_order
+```
+
+::: sqlalchemy_pgview.get_dependency_order

docs/api/dependencies/get-reverse-dependencies.md

@@ -0,0 +1,7 @@
+# `get_reverse_dependencies`
+
+```python
+from sqlalchemy_pgview import get_reverse_dependencies
+```
+
+::: sqlalchemy_pgview.get_reverse_dependencies

docs/api/dependencies/get-view-definition.md

@@ -0,0 +1,7 @@
+# `get_view_definition`
+
+```python
+from sqlalchemy_pgview import get_view_definition
+```
+
+::: sqlalchemy_pgview.get_view_definition

docs/api/dependencies/get-view-dependencies.md

@@ -0,0 +1,7 @@
+# `get_view_dependencies`
+
+```python
+from sqlalchemy_pgview import get_view_dependencies
+```
+
+::: sqlalchemy_pgview.get_view_dependencies

docs/api/dependencies/view-dependency.md

@@ -0,0 +1,17 @@
+# `ViewDependency` class
+
+Represents a dependency between views.
+
+```python
+from sqlalchemy_pgview import ViewDependency
+```
+
+::: sqlalchemy_pgview.ViewDependency
+    options:
+        members:
+            - dependent_view
+            - dependent_schema
+            - referenced_view
+            - referenced_schema
+            - dependent_fullname
+            - referenced_fullname

docs/api/dependencies/view-info.md

@@ -0,0 +1,16 @@
+# `ViewInfo` class
+
+Information about a view from the database.
+
+```python
+from sqlalchemy_pgview import ViewInfo
+```
+
+::: sqlalchemy_pgview.ViewInfo
+    options:
+        members:
+            - name
+            - schema
+            - definition
+            - is_materialized
+            - fullname

docs/api/views/auto-refresh-context.md

@@ -0,0 +1,9 @@
+# `AutoRefreshContext` class
+
+Context manager for auto-refreshing materialized views when using SQLAlchemy Core.
+
+```python
+from sqlalchemy_pgview import AutoRefreshContext
+```
+
+::: sqlalchemy_pgview.AutoRefreshContext

docs/api/views/get-materialized-views.md

@@ -0,0 +1,7 @@
+# `get_materialized_views`
+
+```python
+from sqlalchemy_pgview import get_materialized_views
+```
+
+::: sqlalchemy_pgview.get_materialized_views

docs/api/views/get-views.md

@@ -0,0 +1,7 @@
+# `get_views`
+
+```python
+from sqlalchemy_pgview import get_views
+```
+
+::: sqlalchemy_pgview.get_views

docs/api/views/materialized-view.md

@@ -0,0 +1,13 @@
+# `MaterializedView` class
+
+Here's the reference for the `MaterializedView` class, which extends `View` with materialized view features.
+
+```python
+from sqlalchemy_pgview import MaterializedView
+```
+
+::: sqlalchemy_pgview.MaterializedView
+    options:
+        members:
+            - refresh
+            - auto_refresh_on

docs/api/views/view.md

@@ -0,0 +1,17 @@
+# `View` class
+
+Here's the reference for the `View` class, with all its parameters, attributes and methods.
+
+You can import it directly from `sqlalchemy_pgview`:
+
+```python
+from sqlalchemy_pgview import View
+```
+
+::: sqlalchemy_pgview.View
+    options:
+        members:
+            - fullname
+            - columns
+            - as_table
+            - as_from_clause