Skip to content
Snippets Groups Projects
Commit 2530d675 authored by S.Listl's avatar S.Listl
Browse files

Sql_lib documentation: added chapter for .build and .toString

parent ff687263
No related branches found
No related tags found
No related merge requests found
......@@ -274,6 +274,24 @@ var costData = newSelect("CAMPAIGNCOSTID, CAMPAIGNSTEP_ID, CAMPAIGNSTEP.NAME, CA
`orderBy(pFields)` adds an order by statement to the SQL code. The parameter can be filled the same way as `.select(pFields)`.
=== building the SQL statement
==== prepared array
`.build(pDefaultConditionIfNone)` generates a prepared-statement array from the SqlBuilder in the correct form for several `db.` functions.
==== string
`.toString(pDefaultConditionIfNone)` translates the query into a SQL-string.
==== When to use build and when to use toString
`.build()` has to be called before the statement is given to a `db.` method, like `db.cell()` or `db.table()`. But SqlBuilder also provides own functions for executing the query, if you use these, you don't need `.build()`. These methods are explained in the next chapter. Because of a more concise syntax and additional checks that are done in these functions, you should prefer them over the default `db.` methods.
`.toString()` is for cases where you need the query as string, but you should prefer `.build()` whenever possible. Processes like the "conditionProcess" in a dbRecordContainer and the "expression" from a dbRecordContainer field require a string as result, so you should use it there. If `result.string()` is used, you can omit the `.toString()`, since it would then be called implicitly.
TIP: `.toString()` can be useful for logging, as you get an easy to read SQL string.
=== db. function wrappers
==== select functions
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment