@@ -12,7 +12,7 @@ Injected database interface dependencies
1212
1313## Functions
1414
15- ### ` provide_database_interface ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L69 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
15+ ### ` provide_database_interface ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L68 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
1616
1717``` python
1818provide_database_interface() -> ' PrefectDBInterface'
@@ -25,7 +25,7 @@ If components of the interface are not set, defaults will be inferred
2525based on the dialect of the connection URL.
2626
2727
28- ### ` inject_db ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L143 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
28+ ### ` inject_db ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L142 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
2929
3030``` python
3131inject_db(fn: Callable[P, R]) -> Callable[P, R]
@@ -38,7 +38,7 @@ The decorated function _must_ take a `db` kwarg and if a db is passed
3838when called it will be used instead of creating a new one.
3939
4040
41- ### ` db_injector ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L178 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
41+ ### ` db_injector ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L177 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
4242
4343``` python
4444db_injector(func: Union[_DBMethod[T, P, R], _DBFunction[P, R]]) -> Union[_Method[T, P, R], _Function[P, R]]
@@ -65,7 +65,7 @@ iscoroutinefunction() test.
6565- binding transparently.
6666
6767
68- ### ` temporary_database_config ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L361 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
68+ ### ` temporary_database_config ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L346 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
6969
7070``` python
7171temporary_database_config(tmp_database_config: Optional[BaseDatabaseConfiguration]) -> Generator[None , object , None ]
@@ -80,7 +80,7 @@ be restored.
8080- ` tmp_database_config ` : Prefect REST API database configuration to inject.
8181
8282
83- ### ` temporary_query_components ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L382 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
83+ ### ` temporary_query_components ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L367 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
8484
8585``` python
8686temporary_query_components(tmp_queries: Optional[' BaseQueryComponents' ]) -> Generator[None , object , None ]
@@ -95,7 +95,7 @@ be restored.
9595- ` tmp_queries ` : Prefect REST API query components to inject.
9696
9797
98- ### ` temporary_orm_config ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L403 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
98+ ### ` temporary_orm_config ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L388 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
9999
100100``` python
101101temporary_orm_config(tmp_orm_config: Optional[' BaseORMConfiguration' ]) -> Generator[None , object , None ]
@@ -110,7 +110,7 @@ be restored.
110110- ` tmp_orm_config ` : Prefect REST API ORM configuration to inject.
111111
112112
113- ### ` temporary_interface_class ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L424 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
113+ ### ` temporary_interface_class ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L409 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
114114
115115``` python
116116temporary_interface_class(tmp_interface_class: Optional[type[' PrefectDBInterface' ]]) -> Generator[None , object , None ]
@@ -124,7 +124,7 @@ the existing interface will be restored.
124124- ` tmp_interface_class ` : Prefect REST API interface class to inject.
125125
126126
127- ### ` temporary_database_interface ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L444 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
127+ ### ` temporary_database_interface ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L429 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
128128
129129``` python
130130temporary_database_interface(tmp_database_config: Optional[BaseDatabaseConfiguration] = None , tmp_queries: Optional[' BaseQueryComponents' ] = None , tmp_orm_config: Optional[' BaseORMConfiguration' ] = None , tmp_interface_class: Optional[type[' PrefectDBInterface' ]] = None ) -> Generator[None , object , None ]
@@ -147,7 +147,7 @@ be restored.
147147- ` tmp_interface_class ` : Optional database interface class to inject
148148
149149
150- ### ` set_database_config ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L479 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
150+ ### ` set_database_config ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L464 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
151151
152152``` python
153153set_database_config(database_config: Optional[BaseDatabaseConfiguration]) -> None
@@ -157,7 +157,7 @@ set_database_config(database_config: Optional[BaseDatabaseConfiguration]) -> Non
157157Set Prefect REST API database configuration.
158158
159159
160- ### ` set_query_components ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L484 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
160+ ### ` set_query_components ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L469 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
161161
162162``` python
163163set_query_components(query_components: Optional[' BaseQueryComponents' ]) -> None
@@ -167,7 +167,7 @@ set_query_components(query_components: Optional['BaseQueryComponents']) -> None
167167Set Prefect REST API query components.
168168
169169
170- ### ` set_orm_config ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L489 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
170+ ### ` set_orm_config ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L474 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
171171
172172``` python
173173set_orm_config(orm_config: Optional[' BaseORMConfiguration' ]) -> None
@@ -177,7 +177,7 @@ set_orm_config(orm_config: Optional['BaseORMConfiguration']) -> None
177177Set Prefect REST API orm configuration.
178178
179179
180- ### ` set_interface_class ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L494 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
180+ ### ` set_interface_class ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L479 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
181181
182182``` python
183183set_interface_class(interface_class: Optional[type[' PrefectDBInterface' ]]) -> None
@@ -189,4 +189,4 @@ Set Prefect REST API interface class.
189189
190190## Classes
191191
192- ### ` DBInjector ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L254 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
192+ ### ` DBInjector ` <sup ><a href = " https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/dependencies.py#L239 " target = " _blank" ><Icon icon = " github" style = " width: 14px; height: 14px;" /></a ></sup >
0 commit comments