Skip to content

[SYNPY-1896] Add SearchIndex to operations/utility_operations.py #1445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BryanFauble merged 2 commits into from
Aug 18, 2026
+23 −12
Merged

[SYNPY-1896] Add SearchIndex to operations/utility_operations.py #1445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff215cd
[SYNPY-1896] Add SearchIndex to operations/utility_operations.py
BryanFauble Aug 14, 2026
a4ecad8
Add SearchIndex to web services API
BryanFauble Aug 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions synapseclient/api/web_services.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
MaterializedView,
Project,
RecordSet,
SearchIndex,
SubmissionView,
Table,
VirtualTable,
Expand All @@ -35,6 +36,7 @@ async def open_entity_in_browser(
"MaterializedView",
"Project",
"RecordSet",
"SearchIndex",
"SubmissionView",
"Table",
"VirtualTable",
Expand Down
33 changes: 21 additions & 12 deletions synapseclient/operations/utility_operations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
MaterializedView,
Project,
RecordSet,
SearchIndex,
SubmissionView,
Table,
VirtualTable,
Expand All @@ -38,6 +39,7 @@ def find_entity_id(
"MaterializedView",
"Project",
"RecordSet",
"SearchIndex",
Comment thread
BryanFauble marked this conversation as resolved.
"SubmissionView",
"Table",
"VirtualTable",
Expand All @@ -52,9 +54,9 @@ def find_entity_id(
Arguments:
name: Name of the entity to find.
parent: An Entity object (Dataset, DatasetCollection, EntityView, File,
Folder, Link, MaterializedView, Project, RecordSet, SubmissionView,
Table, VirtualTable) or the Id of an entity as a string. Omit if
searching for a Project by name.
Folder, Link, MaterializedView, Project, RecordSet, SearchIndex,
SubmissionView, Table, VirtualTable) or the Id of an entity as a
string. Omit if searching for a Project by name.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
instance from the Synapse class constructor.
Expand Down Expand Up @@ -141,6 +143,7 @@ async def find_entity_id_async(
"MaterializedView",
"Project",
"RecordSet",
"SearchIndex",
Comment thread
BryanFauble marked this conversation as resolved.
"SubmissionView",
"Table",
"VirtualTable",
Expand All @@ -155,9 +158,9 @@ async def find_entity_id_async(
Arguments:
name: Name of the entity to find.
parent: An Entity object (Dataset, DatasetCollection, EntityView, File,
Folder, Link, MaterializedView, Project, RecordSet, SubmissionView,
Table, VirtualTable) or the Id of an entity as a string. Omit if
searching for a Project by name.
Folder, Link, MaterializedView, Project, RecordSet, SearchIndex,
SubmissionView, Table, VirtualTable) or the Id of an entity as a
string. Omit if searching for a Project by name.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
instance from the Synapse class constructor.
Expand Down Expand Up @@ -380,6 +383,7 @@ def onweb(
"MaterializedView",
"Project",
"RecordSet",
"SearchIndex",
"SubmissionView",
"Table",
"VirtualTable",
Expand All @@ -394,7 +398,8 @@ def onweb(
Arguments:
entity: Either an Entity object (Dataset, DatasetCollection, EntityView,
File, Folder, Link, MaterializedView, Project, RecordSet,
SubmissionView, Table, VirtualTable) or a Synapse ID string.
SearchIndex, SubmissionView, Table, VirtualTable) or a Synapse
ID string.
subpage_id: (Optional) ID of one of the wiki's sub-pages.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
Expand Down Expand Up @@ -470,6 +475,7 @@ async def onweb_async(
"MaterializedView",
"Project",
"RecordSet",
"SearchIndex",
"SubmissionView",
"Table",
"VirtualTable",
Expand All @@ -484,7 +490,8 @@ async def onweb_async(
Arguments:
entity: Either an Entity object (Dataset, DatasetCollection, EntityView,
File, Folder, Link, MaterializedView, Project, RecordSet,
SubmissionView, Table, VirtualTable) or a Synapse ID string.
SearchIndex, SubmissionView, Table, VirtualTable) or a Synapse
ID string.
subpage_id: (Optional) ID of one of the wiki's sub-pages.
synapse_client: If not passed in and caching was not disabled by
`Synapse.allow_client_caching(False)` this will use the last created
Expand Down Expand Up @@ -728,6 +735,7 @@ def print_entity(
"MaterializedView",
"Project",
"RecordSet",
"SearchIndex",
"SubmissionView",
"Table",
"VirtualTable",
Expand All @@ -742,8 +750,8 @@ def print_entity(
Arguments:
entity: Either an Entity object (Dataset, DatasetCollection, EntityView,
File, Folder, Link, MaterializedView, Project, RecordSet,
SubmissionView, Table, VirtualTable), a Synapse ID string, or a
dictionary representation of an entity.
SearchIndex, SubmissionView, Table, VirtualTable), a Synapse ID
string, or a dictionary representation of an entity.
ensure_ascii: If True, escapes all non-ASCII characters in the output.
Defaults to True.
synapse_client: If not passed in and caching was not disabled by
Expand Down Expand Up @@ -819,6 +827,7 @@ async def print_entity_async(
"MaterializedView",
"Project",
"RecordSet",
"SearchIndex",
"SubmissionView",
"Table",
"VirtualTable",
Expand All @@ -833,8 +842,8 @@ async def print_entity_async(
Arguments:
entity: Either an Entity object (Dataset, DatasetCollection, EntityView,
File, Folder, Link, MaterializedView, Project, RecordSet,
SubmissionView, Table, VirtualTable), a Synapse ID string, or a
dictionary representation of an entity.
SearchIndex, SubmissionView, Table, VirtualTable), a Synapse ID
string, or a dictionary representation of an entity.
ensure_ascii: If True, escapes all non-ASCII characters in the output.
Defaults to True.
synapse_client: If not passed in and caching was not disabled by
Expand Down
Loading