Skip to content

Commit bdaa374

Browse files
committed
remove from_path and from_sql from api docs
1 parent 42bdf51 commit bdaa374

File tree

2 files changed

+3
-19
lines changed

2 files changed

+3
-19
lines changed

docs/api.md

+3-17
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ register_entities(entities=[my_function, my_view], exclude_schema=['audit'])
1515

1616
::: alembic_utils.pg_function.PGFunction
1717
:docstring:
18-
:members: from_sql from_path
1918

2019
```python
2120
from alembic_utils.pg_function import PGFunction
@@ -30,7 +29,6 @@ to_lower = PGFunction(
3029

3130
::: alembic_utils.pg_view.PGView
3231
:docstring:
33-
:members: from_sql from_path
3432

3533

3634
```python
@@ -45,33 +43,22 @@ scifi_books = PGView(
4543

4644
::: alembic_utils.pg_materialized_view.PGMaterializedView
4745
:docstring:
48-
:members: from_sql from_path
4946

5047

5148
```python
5249
from alembic_utils.pg_materialized_view import PGMaterializedView
5350

5451
scifi_books = PGMaterializedView(
5552
schema="public",
56-
signature="scifi_books_with_authors",
57-
definition="""
58-
SELECT
59-
b.title,
60-
b.isbn,
61-
a.name,
62-
a.home_city
63-
FROM books b
64-
JOIN authors a ON b.author_id = a.id
65-
where b.genre='scifi'
66-
""",
67-
with_data=False
53+
signature="scifi_books",
54+
definition="select * from books where genre='scifi'",
55+
with_data=True
6856
)
6957
```
7058

7159

7260
::: alembic_utils.pg_trigger.PGTrigger
7361
:docstring:
74-
:members: from_sql from_path
7562

7663

7764
```python
@@ -104,7 +91,6 @@ extension = PGExtension(
10491

10592
::: alembic_utils.pg_policy.PGPolicy
10693
:docstring:
107-
:members: from_sql from_path
10894

10995

11096
```python

src/alembic_utils/replaceable_entity.py

-2
Original file line numberDiff line numberDiff line change
@@ -193,8 +193,6 @@ def register_entities(
193193
194194
**Deprecated Parameters:**
195195
196-
.. deprecated:: 0.5.1 for removal in 0.6.0
197-
198196
*Configure schema and object inclusion/exclusion with `include_name` and `include_object` in `env.py`. For more information see https://alembic.sqlalchemy.org/en/latest/autogenerate.html#controlling-what-to-be-autogenerated*
199197
200198

0 commit comments

Comments
 (0)