Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This document is about a proposed replacement for the POST /table/sql/transform service. It is tracked by

Jira Legacy
serverSystem JIRA
serverIdba6fb084-9827-3160-8067-8ac7470f78b2
keyPLFM-6275
.

Background

The POST /table/sql/transform service is used to transform a complex Synapse Table query object, which may contain filters applied via SQL and selectedFacets, to a single SQL query string.

...

This has created an issue in the web client where a filter may be applied via additionalFilters, but is not shown in the SQL provided by the Transform SQL service. See

Jira Legacy
serverSystem JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverIdba6fb084-9827-3160-8067-8ac7470f78b2
keyPORTALS-2308
for more information.

Proposal

We propose adding the SQL transformation operation to the QueryBundleRequest + QueryResultBundle and deprecating the existing SQL transform service.

...

The client would lose the ability to generate SQL for an arbitrary set of columns, but we do not believe that to be a real use case.

API Changes

We propose adding the following field to the QueryResultBundle object:

...

We will deprecate the POST /table/sql/transform. Once we verify no clients are using the service (we suspect the web client is the only client that makes the request, but have not confirmed), it will be removed.

Examples

The following examples show current and proposed behavior for the service.

...