Skip to content

MS SQL syntax for LIMIT/OFFSET #312

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
merged 20 commits into from
Nov 6, 2022
Merged

MS SQL syntax for LIMIT/OFFSET #312

Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
14cf90a
add mssql LIMIT/OFFSET syntax
Nov 1, 2022
18a4442
tests
Nov 1, 2022
a1136c5
lint
Nov 1, 2022
2aa598c
correct ORDER BY injection position
Nov 1, 2022
07328c0
more concise
Nov 1, 2022
8f3e25d
test for no slice from
Nov 1, 2022
e5dfbf8
lint 2.0
Nov 1, 2022
e7a5806
cleanup whitespace
Nov 1, 2022
1b91cdc
escaping sort, filter and order by
Nov 2, 2022
cf1e504
throw if selected column is * with mssql
Nov 2, 2022
a14b272
test for escaping
Nov 2, 2022
333beef
prettier table.mjs
Nov 2, 2022
71c0bfc
prettier table-test.mjs
Nov 2, 2022
d889a6f
checking for operands in filter and throw if missing
Nov 4, 2022
267af6c
do not mutate escape when needed
Nov 4, 2022
f4a8b6d
pass escaper as an argument (#314)
mbostock Nov 4, 2022
d1007b3
handling no columns correctly
Nov 4, 2022
669c86b
use select.columns explicitely
Nov 4, 2022
567231f
make right query if no column but sorter specified
Nov 4, 2022
557c18d
prettier
Nov 4, 2022
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
66 changes: 45 additions & 21 deletions src/table.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,20 +248,44 @@ export function makeQueryTemplate(operations, source) {
];
for (let i = 0; i < filter.length; ++i) {
appendSql(i ? `\nAND ` : `\nWHERE `, args);
appendWhereEntry(filter[i], args);
appendWhereEntry(filter[i], args, escaper);
}
for (let i = 0; i < sort.length; ++i) {
appendSql(i ? `, ` : `\nORDER BY `, args);
appendOrderBy(sort[i], args);
appendOrderBy(sort[i], args, escaper);
}
if (slice.to !== null || slice.from !== null) {
appendSql(
`\nLIMIT ${slice.to !== null ? slice.to - (slice.from || 0) : 1e9}`,
args
);
}
if (slice.from !== null) {
appendSql(` OFFSET ${slice.from}`, args);
if (source.dialect === "mssql") {
if (slice.to !== null || slice.from !== null) {
if (!sort.length) {
if (columns[0] === "*")
throw new Error(
"at least one column must be explicitly specified. Received '*'."
);
appendSql(`\nORDER BY `, args);
appendOrderBy(
{column: select.columns[0], direction: "ASC"},
args,
escaper
);
}
appendSql(`\nOFFSET ${slice.from || 0} ROWS`, args);
appendSql(
`\nFETCH NEXT ${
slice.to !== null ? slice.to - (slice.from || 0) : 1e9
} ROWS ONLY`,
args
);
}
} else {
if (slice.to !== null || slice.from !== null) {
appendSql(
`\nLIMIT ${slice.to !== null ? slice.to - (slice.from || 0) : 1e9}`,
args
);
}
if (slice.from !== null) {
appendSql(` OFFSET ${slice.from}`, args);
}
}
return args;
}
Expand All @@ -282,16 +306,16 @@ function appendSql(sql, args) {
strings[strings.length - 1] += sql;
}

function appendOrderBy({column, direction}, args) {
appendSql(`t.${column} ${direction.toUpperCase()}`, args);
function appendOrderBy({column, direction}, args, escaper) {
appendSql(`t.${escaper(column)} ${direction.toUpperCase()}`, args);
}

function appendWhereEntry({type, operands}, args) {
function appendWhereEntry({type, operands}, args, escaper) {
if (operands.length < 1) throw new Error("Invalid operand length");

// Unary operations
if (operands.length === 1) {
appendOperand(operands[0], args);
appendOperand(operands[0], args, escaper);
switch (type) {
case "n":
appendSql(` IS NULL`, args);
Expand All @@ -310,7 +334,7 @@ function appendWhereEntry({type, operands}, args) {
// Fallthrough to next parent block.
} else if (["c", "nc"].includes(type)) {
// TODO: Case (in)sensitive?
appendOperand(operands[0], args);
appendOperand(operands[0], args, escaper);
switch (type) {
case "c":
appendSql(` LIKE `, args);
Expand All @@ -319,10 +343,10 @@ function appendWhereEntry({type, operands}, args) {
appendSql(` NOT LIKE `, args);
break;
}
appendOperand(likeOperand(operands[1]), args);
appendOperand(likeOperand(operands[1]), args, escaper);
return;
} else {
appendOperand(operands[0], args);
appendOperand(operands[0], args, escaper);
switch (type) {
case "eq":
appendSql(` = `, args);
Expand All @@ -345,13 +369,13 @@ function appendWhereEntry({type, operands}, args) {
default:
throw new Error("Invalid filter operation");
}
appendOperand(operands[1], args);
appendOperand(operands[1], args, escaper);
return;
}
}

// List operations
appendOperand(operands[0], args);
appendOperand(operands[0], args, escaper);
switch (type) {
case "in":
appendSql(` IN (`, args);
Expand All @@ -366,9 +390,9 @@ function appendWhereEntry({type, operands}, args) {
appendSql(")", args);
}

function appendOperand(o, args) {
function appendOperand(o, args, escaper) {
if (o.type === "column") {
appendSql(`t.${o.value}`, args);
appendSql(`t.${escaper(o.value)}`, args);
} else {
args.push(o.value);
args[0].push("");
Expand Down
146 changes: 146 additions & 0 deletions test/table-test.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,53 @@ describe("makeQueryTemplate", () => {
assert.deepStrictEqual(params, ["val1"]);
});

it("makeQueryTemplate filter and escape filters column", () => {
const source = {name: "db", dialect: "postgres", escape: (i) => `_${i}_`};
const operations = {
...baseOperations,
filter: [
{
type: "eq",
operands: [
{type: "column", value: "col2"},
{type: "resolved", value: "val1"}
]
}
]
};

const [parts, ...params] = makeQueryTemplate(operations, source);
assert.deepStrictEqual(
parts.join("?"),
"SELECT t._col1_,t._col2_ FROM table1 t\nWHERE t._col2_ = ?"
);
assert.deepStrictEqual(params, ["val1"]);
});

it("makeQueryTemplate filter and escape filters column only once", () => {
const source = {name: "db", dialect: "postgres", escape: (i) => `_${i}_`};
const operations = {
...baseOperations,
filter: [
{
type: "eq",
operands: [
{type: "column", value: "col2"},
{type: "resolved", value: "val1"}
]
}
]
};

makeQueryTemplate(operations, source);
const [parts, ...params] = makeQueryTemplate(operations, source);
assert.deepStrictEqual(
parts.join("?"),
"SELECT t._col1_,t._col2_ FROM table1 t\nWHERE t._col2_ = ?"
);
assert.deepStrictEqual(params, ["val1"]);
});

it("makeQueryTemplate filter list", () => {
const source = {name: "db", dialect: "postgres"};
const operations = {
Expand Down Expand Up @@ -164,6 +211,24 @@ describe("makeQueryTemplate", () => {
assert.deepStrictEqual(params, []);
});

it("makeQueryTemplate sort and escape sort column", () => {
const source = {name: "db", dialect: "mysql", escape: (i) => `_${i}_`};
const operations = {
...baseOperations,
sort: [
{column: "col1", direction: "asc"},
{column: "col2", direction: "desc"}
]
};

const [parts, ...params] = makeQueryTemplate(operations, source);
assert.deepStrictEqual(
parts.join("?"),
"SELECT t._col1_,t._col2_ FROM table1 t\nORDER BY t._col1_ ASC, t._col2_ DESC"
);
assert.deepStrictEqual(params, []);
});

it("makeQueryTemplate slice", () => {
const source = {name: "db", dialect: "mysql"};
const operations = {...baseOperations};
Expand Down Expand Up @@ -215,6 +280,87 @@ describe("makeQueryTemplate", () => {
assert.deepStrictEqual(parts.join("?"), "SELECT t.col1,t.col2,t.col3 FROM table1 t\nWHERE t.col1 >= ?\nAND t.col2 = ?\nORDER BY t.col1 ASC\nLIMIT 90 OFFSET 10");
assert.deepStrictEqual(params, ["val1", "val2"]);
});

it("makeQueryTemplate select, slice and escape column name with mssql syntax", () => {
const source = {name: "db", dialect: "mssql", escape: (i) => `_${i}_`};
const operations = {
...baseOperations,
select: {
columns: ["col1", "col2", "col3"]
},
slice: {to: 100}
};

const [parts] = makeQueryTemplate(operations, source);
assert.deepStrictEqual(
parts.join("?"),
"SELECT t._col1_,t._col2_,t._col3_ FROM table1 t\nORDER BY t._col1_ ASC\nOFFSET 0 ROWS\nFETCH NEXT 100 ROWS ONLY"
);
});

it("makeQueryTemplate select, sort, slice, filter indexed with mssql syntax", () => {
const source = {name: "db", dialect: "mssql"};
const operations = {
...baseOperations,
select: {
columns: ["col1", "col2", "col3"]
},
sort: [{column: "col2", direction: "desc"}],
slice: {from: 10, to: 100},
filter: [
{
type: "gte",
operands: [
{type: "column", value: "col1"},
{type: "resolved", value: "val1"}
]
},
{
type: "eq",
operands: [
{type: "column", value: "col2"},
{type: "resolved", value: "val2"}
]
}
]
};

const [parts, ...params] = makeQueryTemplate(operations, source);
assert.deepStrictEqual(parts.join("?"), "SELECT t.col1,t.col2,t.col3 FROM table1 t\nWHERE t.col1 >= ?\nAND t.col2 = ?\nORDER BY t.col2 DESC\nOFFSET 10 ROWS\nFETCH NEXT 90 ROWS ONLY");
assert.deepStrictEqual(params, ["val1", "val2"]);
});

it("makeQueryTemplate throw if no columns are explicitly specified for mssql dialect", () => {
const source = {name: "db", dialect: "mssql"};
const operations = {
...baseOperations,
select: {
columns: []
},
sort: [{column: "col2", direction: "desc"}],
slice: {from: 10, to: 100},
filter: [
{
type: "gte",
operands: [
{type: "column", value: "col1"},
{type: "resolved", value: "val1"}
]
},
{
type: "eq",
operands: [
{type: "column", value: "col2"},
{type: "resolved", value: "val2"}
]
}
]
};

assert.throws(() => {
makeQueryTemplate(operations, source);
}, Error);
});
});

describe("__table", () => {
Expand Down