renderSqlFile: Render a SQL file

In SqlRender: Rendering Parameterized SQL and Translation to Dialects

Render a SQL file

Description

renderSqlFile Renders SQL code in a file based on parameterized SQL and parameter values, and writes it to another file.

Usage

renderSqlFile(sourceFile, targetFile, warnOnMissingParameters = TRUE, ...)

Arguments

sourceFile	The source SQL file
targetFile	The target SQL file
warnOnMissingParameters	Should a warning be raised when parameters provided to this function do not appear in the parameterized SQL that is being rendered? By default, this is TRUE.
...	Parameter values

Details

This function takes parameterized SQL and a list of parameter values and renders the SQL that can be send to the server. Parameterization syntax:

@parameterName

Parameters are indicated using a @ prefix, and are replaced with the actual values provided in the render call.

{DEFAULT @parameterName = parameterValue}

Default values for parameters can be defined using curly and the DEFAULT keyword.

{if}?{then}:{else}

The if-then-else pattern is used to turn on or off blocks of SQL code.

Examples

## Not run: 
renderSqlFile("myParamStatement.sql", "myRenderedStatement.sql", a = "myTable")

## End(Not run)

SqlRender documentation built on Oct. 9, 2024, 9:07 a.m.