prefect.server.models.saved_searches
¶
Functions for interacting with saved search ORM objects. Intended for internal use by the Prefect REST API.
create_saved_search
async
¶
Upserts a SavedSearch.
If a SavedSearch with the same name exists, all properties will be updated.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session |
Session
|
a database session |
required |
saved_search |
SavedSearch
|
a SavedSearch model |
required |
Returns:
Type | Description |
---|---|
db.SavedSearch: the newly-created or updated SavedSearch |
Source code in prefect/server/models/saved_searches.py
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
|
delete_saved_search
async
¶
Delete a SavedSearch by id.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session |
Session
|
A database session |
required |
saved_search_id |
str
|
a SavedSearch id |
required |
Returns:
Name | Type | Description |
---|---|---|
bool |
bool
|
whether or not the SavedSearch was deleted |
Source code in prefect/server/models/saved_searches.py
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
|
read_saved_search
async
¶
Reads a SavedSearch by id.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session |
Session
|
A database session |
required |
saved_search_id |
str
|
a SavedSearch id |
required |
Returns:
Type | Description |
---|---|
db.SavedSearch: the SavedSearch |
Source code in prefect/server/models/saved_searches.py
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
|
read_saved_search_by_name
async
¶
Reads a SavedSearch by name.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session |
Session
|
A database session |
required |
name |
str
|
a SavedSearch name |
required |
Returns:
Type | Description |
---|---|
db.SavedSearch: the SavedSearch |
Source code in prefect/server/models/saved_searches.py
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
|
read_saved_searches
async
¶
Read SavedSearches.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session |
Session
|
A database session |
required |
offset |
int
|
Query offset |
None
|
limit(int) |
Query limit |
required |
Returns:
Type | Description |
---|---|
List[db.SavedSearch]: SavedSearches |
Source code in prefect/server/models/saved_searches.py
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
|