Skip to content

Add includeViewDataUrl and includeTitle parameters to Query.getQueries() #141

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.

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
merged 4 commits into from
Jan 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## 1.18.0 - 2023-01-03
- [Issue 47010](https://www.labkey.org/home/Developer/issues/issues-details.view?issueId=47010): Add `includeViewDataUrl` and `includeTitle` parameters to `Query.getQueries()`. Setting these to `false` (along with existing parameter `includeColumns`) can improve performance of getQueries() calls.

## 1.17.1 - 2022-12-19
- Fix URI decoding for paths with encoded characters in container names

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ can do so via the following steps:
1. Build the package (as described above).
1. Copy the package's `/dist` directory to `/<labkey root>/server/modules/platform/core/node_modules/@labkey/api/dist`.
1. Navigate to `/<labkey root>/server/modules/platform/core`.
1. Run `node build.js` from the `core` module directory.
1. Run `npm run copy-distributions` from the `core` module directory.

Your changes will now be included in the bundle served by your local LabKey Server instance.

Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@labkey/api",
"version": "1.17.1",
"version": "1.18.0",
"description": "JavaScript client API for LabKey Server",
"scripts": {
"build": "npm run build:dist && npm run build:docs",
Expand Down
8 changes: 7 additions & 1 deletion src/labkey/query/Utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -245,8 +245,12 @@ export interface GetQueriesOptions extends RequestCallbackOptions<GetQueriesResp
includeColumns?: boolean;
/** If set to false, system-defined queries will not be included in the results. Default is true. */
includeSystemQueries?: boolean;
/** If set to false, no custom query titles will be included. Instead, titles will be identical to names. Default is true. */
includeTitle?: boolean;
/** If set to false, user-defined queries will not be included in the results. Default is true. */
includeUserQueries?: boolean;
/** If set to false, view data URLs will not be included in the results. Default is true. */
includeViewDataUrl?: boolean;
/**
* If set to true, and includeColumns is set to true, information about the available columns
* will be the same details as specified by [[getQueryDetails]] for columns.
Expand All @@ -270,8 +274,10 @@ export function getQueries(options: GetQueriesOptions): XMLHttpRequest {
{
schemaName: 'schemaName',
includeColumns: 'includeColumns',
includeUserQueries: 'includeUserQueries',
includeSystemQueries: 'includeSystemQueries',
includeTitle: 'includeTitle',
includeUserQueries: 'includeUserQueries',
includeViewDataUrl: 'includeViewDataUrl',
queryDetailColumns: 'queryDetailColumns',
},
false,
Expand Down