Skip to content
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

[PoC]: SQL Native FOR JSON implemenation #766

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

[PoC]: SQL Native FOR JSON implemenation #766

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c023b09
SQL native FOR JSON alternative
BobdenOs Aug 1, 2024
7fc5788
Add some more escaped characters tests
BobdenOs Aug 1, 2024
4e3df95
Merge branch 'main' of https://github.com/cap-js/cds-dbs into exp/han…
BobdenOs Feb 13, 2025
508cee0
Adjust for skipped path
BobdenOs Feb 13, 2025
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
30 changes: 21 additions & 9 deletions hana/lib/HANAService.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

const DEBUG = cds.debug('sql|db')
let HANAVERSION = 0
const JSON_CONCAT = true
const SANITIZE_VALUES = process.env.NODE_ENV === 'production' && cds.env.log.sanitize_values !== false

/**
Expand Down Expand Up @@ -141,9 +142,7 @@
const isSimple = temporary.length + blobs.length + withclause.length === 0

// REVISIT: add prepare options when param:true is used
let sqlScript = isLockQuery || isSimple ? sql : this.wrapTemporary(temporary, withclause, blobs)
const { hints } = query.SELECT
if (hints) sqlScript += ` WITH HINT (${hints.join(',')})`
const sqlScript = (isLockQuery || isSimple ? sql : this.wrapTemporary(temporary, withclause, blobs)) + ' WITH HINT(RESULT_CACHE,USE_REMOTE_CACHE)' // RESULT_CACHE_MAX_LAG(1)
let rows
if (values?.length || blobs.length > 0) {
const ps = await this.prepare(sqlScript, blobs.length)
Expand Down Expand Up @@ -521,6 +520,7 @@
let blobs = {}
let hasBooleans = false
let path
let toJson = []
let sql = SELECT.columns
.map(
SELECT.expand === 'root'
Expand Down Expand Up @@ -618,7 +618,9 @@
return false
}
if (x.element?.type === 'cds.Boolean') hasBooleans = true
const converter = x.element?.[this.class._convertOutput] || (e => e)
let converter = x.element?.[this.class._convertOutput] || src?.elements[columnName]?.[this.class._convertOutput]
toJson.push(`${this.string(JSON.stringify(columnName) + ':')} || coalesce((${(converter ? `'"' || ${converter(this.quote(columnName))} || '"'` : this.quote(columnName)) || ''} || ''), 'null')`)
converter ??= e => e
const sql = x.param !== true && typeof x.val === 'number' ? this.expr({ param: false, __proto__: x }) : this.expr(x)
return `${converter(sql, x.element)} as "${columnName.replace(/"/g, '""')}"`
}
Expand Down Expand Up @@ -652,7 +654,9 @@
// Making each row a maximum size of 2gb instead of the whole result set to be 2gb
// Excluding binary columns as they are not supported by FOR JSON and themselves can be 2gb
const rawJsonColumn = sql.length
? `(SELECT ${path ? sql : sql.map(c => c.slice(c.lastIndexOf(' as "') + 4))} FROM JSON_TABLE('{}', '$' COLUMNS("'$$FaKeDuMmYCoLuMn$$'" FOR ORDINALITY)) FOR JSON ('format'='no', 'omitnull'='no', 'arraywrap'='no') RETURNS NVARCHAR(2147483647))`
? JSON_CONCAT
? `'{' || ${toJson.join(` || ',' || `)} || '}'`
: `(SELECT ${path ? sql : sql.map(c => c.slice(c.lastIndexOf(' as "') + 4))} FROM JSON_TABLE('{}', '$' COLUMNS("'$$FaKeDuMmYCoLuMn$$'" FOR ORDINALITY)) FOR JSON ('format'='no', 'omitnull'='no', 'arraywrap'='no') RETURNS NVARCHAR(2147483647))`
: `'{}'`

let jsonColumn = rawJsonColumn
Expand Down Expand Up @@ -1203,10 +1207,10 @@
LargeString: cds.env.features.sql_simple_queries > 0 ? e => `TO_NVARCHAR(${e})` : undefined,
// REVISIT: binaries should use BASE64_ENCODE, but this results in BASE64_ENCODE(BINTONHEX(${e}))
Binary: e => `BINTONHEX(${e})`,
Date: e => `to_char(${e}, 'YYYY-MM-DD')`,
Time: e => `to_char(${e}, 'HH24:MI:SS')`,
DateTime: e => `to_char(${e}, 'YYYY-MM-DD"T"HH24:MI:SS"Z"')`,
Timestamp: e => `to_char(${e}, 'YYYY-MM-DD"T"HH24:MI:SS.FF3"Z"')`,
Date: e => `TO_NVARCHAR(${e}, 'YYYY-MM-DD')`,
Time: e => `TO_NVARCHAR(${e}, 'HH24:MI:SS')`,
DateTime: e => `TO_NVARCHAR(${e}, 'YYYY-MM-DD"T"HH24:MI:SS"Z"')`,
Timestamp: e => `TO_NVARCHAR(${e}, 'YYYY-MM-DD"T"HH24:MI:SS.FF3"Z"')`,
Vector: e => `TO_NVARCHAR(${e})`,
// Reading int64 as string to not loose precision
Int64: expr => `TO_NVARCHAR(${expr})`,
Expand All @@ -1215,6 +1219,10 @@
? `TO_NVARCHAR(${expr}, '0.${''.padEnd(elem.scale, '0')}')`
: `TO_NVARCHAR(${expr})`,

String: JSON_CONCAT
? e => `${['\\', '"', '\b', '\t', '\n', '\f', '\r'].reduce((l, c) => `REPLACE(${l},'${c}','${JSON.stringify(c).slice(1, -1)}')`, e)}`
: undefined,

// HANA types
'cds.hana.ST_POINT': e => `TO_NVARCHAR(${e})`,
'cds.hana.ST_GEOMETRY': e => `TO_NVARCHAR(${e})`,
Expand All @@ -1239,6 +1247,10 @@
// Look for deployment batch dispatch and execute as single query
// When deployment is not executed in a batch it will fail to create views
if (Array.isArray(req.query) && !req.query.find(q => typeof q !== 'string' || this.hasResults(q))) {
const caches = req.query
.filter(q => /(^|')CREATE VIEW (.*) AS/.test(q) && !/[ "]localized[._]/i.test(q))

Check failure

Code scanning / CodeQL

Polynomial regular expression used on uncontrolled data High

This
regular expression
Loading
that depends on
library input
Loading
may run slow on strings starting with 'CREATE VIEW ' and with many repetitions of ''CREATE VIEW a'.
.map(q => `ALTER VIEW ${/(^|')CREATE VIEW (.*) AS/.exec(q)[2]} ADD CACHE RETENTION 60`)

Check failure

Code scanning / CodeQL

Polynomial regular expression used on uncontrolled data High

This
regular expression
Loading
that depends on
library input
Loading
may run slow on strings starting with 'CREATE VIEW ' and with many repetitions of ''CREATE VIEW a'.
req.query.push(...caches)
req.query = `DO BEGIN ${req.query
.map(
q =>
Expand Down
17 changes: 17 additions & 0 deletions test/compliance/resources/db/basic/literals/basic.literals.string.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ const alphabet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'

const alphabetize = (_, i) => alphabet[i % alphabet.length]

const bs = String.fromCharCode(92)

module.exports = [
{
string: null,
Expand Down Expand Up @@ -44,6 +46,21 @@ module.exports = [
string:
'Simplified Chinese: 中国, Traditional Chinese: 中國, Korean: 대한민국, Japanese: 日本国, Russion: Российская Федерация, Greek: Ελληνική Δημοκρατία',
},
{
string: `${bs}\b\t\n\r"${bs}b${bs}t${bs}n${bs}r${bs}"`,
},
{
string: `${bs}b`,
},
{
string: `${bs}`,
},
{
string: `${bs}${bs}`,
},
{
string: `${bs}\b`,
},
/* Ignoring transformations
{
char: () => alphabet,
Expand Down
Loading