Skip to content

GetQueryDetailsAction: Serialize Query Parameters #8034

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

Open
labkey-alan wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

GetQueryDetailsAction: Serialize Query Parameters #8034

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c5fd4e7
GetQueryDetailsAction: serialize named parameters in response
labkey-alan Sep 9, 2026
47f0568
ParameterDecl: Add default toJSON implementation
labkey-alan Sep 9, 2026
c757569
cleanup
labkey-alan Sep 9, 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
12 changes: 12 additions & 0 deletions api/src/org/labkey/api/query/QueryService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,18 @@ interface ParameterDecl extends ParameterDescription
{
Object getDefault();
boolean isRequired();

default JSONObject toJSON()
{
JSONObject json = new JSONObject();

json.put("name", getName());
json.put("defaultValue", getDefault());
json.put("isRequired", isRequired());
json.put("jdbcType", getJdbcType().toString());

return json;
}
}

class ParameterDeclaration extends ParameterDescriptionImpl implements ParameterDecl
Expand Down
6 changes: 6 additions & 0 deletions query/src/org/labkey/query/controllers/GetQueryDetailsAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@
import org.labkey.api.exp.property.Domain;
import org.labkey.api.exp.property.DomainKind;
import org.labkey.api.exp.property.PropertyService;
import org.labkey.api.formSchema.Field;
import org.labkey.api.formSchema.FormSchema;
import org.labkey.api.query.CustomView;
import org.labkey.api.query.DefaultSchema;
import org.labkey.api.query.FieldKey;
Expand Down Expand Up @@ -69,6 +71,7 @@
import org.springframework.beans.PropertyValues;
import org.springframework.validation.BindException;

import java.sql.Array;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
Expand Down Expand Up @@ -168,6 +171,9 @@ public ApiResponse execute(Form form, BindException errors)
resp.put("supportGroupConcatSubSelect", tinfo.getSqlDialect().supportsGroupConcatSubSelect());
resp.put("supportMerge", tinfo.supportsInsertOption(QueryUpdateService.InsertOption.MERGE));

var namedParams = tinfo.getNamedParameters().stream().map(QueryService.ParameterDecl::toJSON).toList();
resp.put("namedParameters", new JSONArray(namedParams));

// check if this query is shadowing a local table
if (isUserDefined)
{
Expand Down
1 change: 1 addition & 0 deletions query/src/org/labkey/query/sql/QParameter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
package org.labkey.query.sql;

import org.jetbrains.annotations.NotNull;
import org.json.JSONObject;

@cnathe cnathe Sep 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unused import?

import org.labkey.api.data.JdbcType;
import org.labkey.api.query.QueryService;

Expand Down