Skip to content

6165: Added truncate_table function. #29

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
RosalineP merged 2 commits into from
Sep 9, 2019
Merged

6165: Added truncate_table function. #29

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
994db79
Added truncate_table function.
RosalineP Aug 26, 2019
8cc8df8
Removed accidental plural, added example usage in documentation file
RosalineP Sep 4, 2019
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
20 changes: 20 additions & 0 deletions labkey/query.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,26 @@ def delete_rows(server_context, schema_name, query_name, rows, container_path=No
return server_context.make_request(url, json_dumps(payload, sort_keys=True), headers=_query_headers, timeout=timeout)


def truncate_table(server_context, schema_name, query_name, container_path=None, timeout=_default_timeout):
"""
Delete all rows from the schema.query
:param server_context: A LabKey server context. See utils.create_server_context.
:param schema_name: schema of table
:param query_name: table name to delete from
:param container_path: labkey container path if not already set in context
:param timeout: timeout of request in seconds (defaults to 30s)
:return:
"""
url = server_context.build_url('query', 'truncateTable.api', container_path=container_path)

payload = {
'schemaName': schema_name,
'queryName': query_name
}

return server_context.make_request(url, json_dumps(payload, sort_keys=True), headers=_query_headers, timeout=timeout)


def execute_sql(server_context, schema_name, sql, container_path=None,
max_rows=None,
sort=None,
Expand Down
9 changes: 8 additions & 1 deletion samples/query_examples.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
from labkey.utils import create_server_context
from labkey.exceptions import RequestError, QueryNotFoundError, ServerContextError, ServerNotFoundError
from labkey.query import select_rows, update_rows, Pagination, QueryFilter, \
insert_rows, delete_rows, execute_sql
insert_rows, delete_rows, truncate_table, execute_sql
from requests.exceptions import Timeout

import copy
Expand Down Expand Up @@ -214,6 +214,13 @@
print('Delete Rows: after row count [ ' + str(all_rows['rowCount']) + ' ]')


###################
# Test truncate_table
###################
truncate_info = truncate_table(server_context, schema, table)
print('Delete all rows in table: [ ' + str(truncate_info['deletedRows']) + ' ] rows deleted')


###################
# Test execute_sql
###################
Expand Down