From aab5d07ca12e813dc63d0c2bb4e8ffb12d2aec1a Mon Sep 17 00:00:00 2001 From: lukaseder Date: Tue, 19 Sep 2017 12:42:03 +0200 Subject: [PATCH] [#6575] Enhance plain SQL templating language documentation with parsing rules --- .../resources/org/jooq/web/manual-3.0.xml | 28 +++++++++++++++++++ .../resources/org/jooq/web/manual-3.1.xml | 28 +++++++++++++++++++ .../resources/org/jooq/web/manual-3.10.xml | 27 ++++++++++++++++++ .../resources/org/jooq/web/manual-3.2.xml | 28 +++++++++++++++++++ .../resources/org/jooq/web/manual-3.3.xml | 28 +++++++++++++++++++ .../resources/org/jooq/web/manual-3.4.xml | 28 +++++++++++++++++++ .../resources/org/jooq/web/manual-3.5.xml | 28 +++++++++++++++++++ .../resources/org/jooq/web/manual-3.6.xml | 28 +++++++++++++++++++ .../resources/org/jooq/web/manual-3.7.xml | 28 +++++++++++++++++++ .../resources/org/jooq/web/manual-3.8.xml | 28 +++++++++++++++++++ .../resources/org/jooq/web/manual-3.9.xml | 27 ++++++++++++++++++ 11 files changed, 306 insertions(+) diff --git a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.0.xml b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.0.xml index 91ec011d90..b9695ee9a3 100644 --- a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.0.xml +++ b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.0.xml @@ -5975,6 +5975,34 @@ field("replace(substr(quote(zeroblob(({0} + 1) / 2)), 3, {0}), '0', {1})", Strin // argument "count" is repeated twice: \------------------+----------|---------------------/ | // argument "string" is used only once: \-----------------------------/]]> + +

Parsing rules

+ +

+ When processing these plain SQL templates, a mini parser is run that handles things like +

+ + + +

+ The above are recognised by the templating engine and contents inside of them are ignored when replacing numbered placeholders and/or bind variables. For instance: +

+ + + +

+ The above query does not contain any numbered placeholders nor bind variables, because the tokens that would otherwise be searched for are contained inside of comments, string literals, or quoted names. +

diff --git a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.1.xml b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.1.xml index b2ae3ea68f..f5214471cc 100644 --- a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.1.xml +++ b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.1.xml @@ -6373,6 +6373,34 @@ field("replace(substr(quote(zeroblob(({0} + 1) / 2)), 3, {0}), '0', {1})", Strin // argument "count" is repeated twice: \------------------+----------|---------------------/ | // argument "string" is used only once: \-----------------------------/]]> + +

Parsing rules

+ +

+ When processing these plain SQL templates, a mini parser is run that handles things like +

+ + + +

+ The above are recognised by the templating engine and contents inside of them are ignored when replacing numbered placeholders and/or bind variables. For instance: +

+ + + +

+ The above query does not contain any numbered placeholders nor bind variables, because the tokens that would otherwise be searched for are contained inside of comments, string literals, or quoted names. +

diff --git a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.10.xml b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.10.xml index 0925882dad..077c4f43a1 100644 --- a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.10.xml +++ b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.10.xml @@ -9456,6 +9456,33 @@ Field c = val("c"); condition("my_column IN ({0}, {1}, {2})", a, b, c); // Using distinct template arguments condition("my_column IN ({0})", list(a, b, c)); // Using a single template argument]]> +

Parsing rules

+ +

+ When processing these plain SQL templates, a mini parser is run that handles things like +

+ + + +

+ The above are recognised by the templating engine and contents inside of them are ignored when replacing numbered placeholders and/or bind variables. For instance: +

+ + + +

+ The above query does not contain any numbered placeholders nor bind variables, because the tokens that would otherwise be searched for are contained inside of comments, string literals, or quoted names. +

diff --git a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.2.xml b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.2.xml index bb61a4e88a..cf0f54d7cf 100644 --- a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.2.xml +++ b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.2.xml @@ -6674,6 +6674,34 @@ field("replace(substr(quote(zeroblob(({0} + 1) / 2)), 3, {0}), '0', {1})", Strin // argument "count" is repeated twice: \------------------+----------|---------------------/ | // argument "string" is used only once: \-----------------------------/]]> + +

Parsing rules

+ +

+ When processing these plain SQL templates, a mini parser is run that handles things like +

+ + + +

+ The above are recognised by the templating engine and contents inside of them are ignored when replacing numbered placeholders and/or bind variables. For instance: +

+ + + +

+ The above query does not contain any numbered placeholders nor bind variables, because the tokens that would otherwise be searched for are contained inside of comments, string literals, or quoted names. +

diff --git a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.3.xml b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.3.xml index 444b4a2d0f..6c58b307ba 100644 --- a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.3.xml +++ b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.3.xml @@ -7329,6 +7329,34 @@ field("replace(substr(quote(zeroblob(({0} + 1) / 2)), 3, {0}), '0', {1})", Strin // argument "count" is repeated twice: \------------------+----------|---------------------/ | // argument "string" is used only once: \-----------------------------/]]> + +

Parsing rules

+ +

+ When processing these plain SQL templates, a mini parser is run that handles things like +

+ + + +

+ The above are recognised by the templating engine and contents inside of them are ignored when replacing numbered placeholders and/or bind variables. For instance: +

+ + + +

+ The above query does not contain any numbered placeholders nor bind variables, because the tokens that would otherwise be searched for are contained inside of comments, string literals, or quoted names. +

diff --git a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.4.xml b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.4.xml index 50d428ff51..98224c5985 100644 --- a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.4.xml +++ b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.4.xml @@ -8239,6 +8239,34 @@ field("replace(substr(quote(zeroblob(({0} + 1) / 2)), 3, {0}), '0', {1})", Strin // argument "count" is repeated twice: \------------------+----------|---------------------/ | // argument "string" is used only once: \-----------------------------/]]> + +

Parsing rules

+ +

+ When processing these plain SQL templates, a mini parser is run that handles things like +

+ + + +

+ The above are recognised by the templating engine and contents inside of them are ignored when replacing numbered placeholders and/or bind variables. For instance: +

+ + + +

+ The above query does not contain any numbered placeholders nor bind variables, because the tokens that would otherwise be searched for are contained inside of comments, string literals, or quoted names. +

diff --git a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.5.xml b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.5.xml index 9ef5cef532..bae4952d9c 100644 --- a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.5.xml +++ b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.5.xml @@ -8636,6 +8636,34 @@ field("replace(substr(quote(zeroblob(({0} + 1) / 2)), 3, {0}), '0', {1})", Strin // argument "count" is repeated twice: \------------------+----------|---------------------/ | // argument "string" is used only once: \-----------------------------/]]> + +

Parsing rules

+ +

+ When processing these plain SQL templates, a mini parser is run that handles things like +

+ + + +

+ The above are recognised by the templating engine and contents inside of them are ignored when replacing numbered placeholders and/or bind variables. For instance: +

+ + + +

+ The above query does not contain any numbered placeholders nor bind variables, because the tokens that would otherwise be searched for are contained inside of comments, string literals, or quoted names. +

diff --git a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.6.xml b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.6.xml index 02c6ca7f77..846aa2cf1e 100644 --- a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.6.xml +++ b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.6.xml @@ -8768,6 +8768,34 @@ Field c = val("c"); condition("my_column IN ({0}, {1}, {2})", a, b, c); // Using distinct template arguments condition("my_column IN ({0})", list(a, b, c)); // Using a single template argument]]> + +

Parsing rules

+ +

+ When processing these plain SQL templates, a mini parser is run that handles things like +

+ +
    +
  • String literals
    • +
  • Quoted names
    • +
  • Comments
    • +
  • JDBC escape sequences
    • +
+ +

+ The above are recognised by the templating engine and contents inside of them are ignored when replacing numbered placeholders and/or bind variables. For instance: +

+ + + +

+ The above query does not contain any numbered placeholders nor bind variables, because the tokens that would otherwise be searched for are contained inside of comments, string literals, or quoted names. +

diff --git a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.7.xml b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.7.xml index a1f3664215..a69c71d2c2 100644 --- a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.7.xml +++ b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.7.xml @@ -9041,6 +9041,34 @@ Field c = val("c"); condition("my_column IN ({0}, {1}, {2})", a, b, c); // Using distinct template arguments condition("my_column IN ({0})", list(a, b, c)); // Using a single template argument]]> + +

Parsing rules

+ +

+ When processing these plain SQL templates, a mini parser is run that handles things like +

+ +
    +
  • String literals
    • +
  • Quoted names
    • +
  • Comments
    • +
  • JDBC escape sequences
    • +
+ +

+ The above are recognised by the templating engine and contents inside of them are ignored when replacing numbered placeholders and/or bind variables. For instance: +

+ + + +

+ The above query does not contain any numbered placeholders nor bind variables, because the tokens that would otherwise be searched for are contained inside of comments, string literals, or quoted names. +

diff --git a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.8.xml b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.8.xml index d9681281a0..14f014f739 100644 --- a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.8.xml +++ b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.8.xml @@ -9265,6 +9265,34 @@ Field c = val("c"); condition("my_column IN ({0}, {1}, {2})", a, b, c); // Using distinct template arguments condition("my_column IN ({0})", list(a, b, c)); // Using a single template argument]]> + +

Parsing rules

+ +

+ When processing these plain SQL templates, a mini parser is run that handles things like +

+ +
    +
  • String literals
    • +
  • Quoted names
    • +
  • Comments
    • +
  • JDBC escape sequences
    • +
+ +

+ The above are recognised by the templating engine and contents inside of them are ignored when replacing numbered placeholders and/or bind variables. For instance: +

+ + + +

+ The above query does not contain any numbered placeholders nor bind variables, because the tokens that would otherwise be searched for are contained inside of comments, string literals, or quoted names. +

diff --git a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.9.xml b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.9.xml index c3a3316181..188a39a393 100644 --- a/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.9.xml +++ b/jOOQ-manual/src/main/resources/org/jooq/web/manual-3.9.xml @@ -9400,6 +9400,33 @@ Field c = val("c"); condition("my_column IN ({0}, {1}, {2})", a, b, c); // Using distinct template arguments condition("my_column IN ({0})", list(a, b, c)); // Using a single template argument]]> +

Parsing rules

+ +

+ When processing these plain SQL templates, a mini parser is run that handles things like +

+ +
    +
  • String literals
    • +
  • Quoted names
    • +
  • Comments
    • +
  • JDBC escape sequences
    • +
+ +

+ The above are recognised by the templating engine and contents inside of them are ignored when replacing numbered placeholders and/or bind variables. For instance: +

+ + + +

+ The above query does not contain any numbered placeholders nor bind variables, because the tokens that would otherwise be searched for are contained inside of comments, string literals, or quoted names. +