Skip to content

    TParams.ParseSQL

    Parse SQL statement, replacing parameter names with SQL parameter placeholders.

    Declaration

    Source position: db.pas line 1551

    public 
function ParseSQL(const SQL: string; DoCreate: Boolean) : string
                 ;  overload; overload;

function ParseSQL(const SQL: string; DoCreate: Boolean; 
                 EscapeSlash: Boolean; EscapeRepeat: Boolean; 
                 ParameterStyle: TParamStyle) : string;  overload; overload;

function ParseSQL(const SQL: string; DoCreate: Boolean; 
                 EscapeSlash: Boolean; EscapeRepeat: Boolean; 
                 ParameterStyle: TParamStyle; 
                 out ParamBinding: TParamBinding) : string;  overload; overload;

function ParseSQL(const SQL: string; DoCreate: Boolean; 
                 EscapeSlash: Boolean; EscapeRepeat: Boolean; 
                 ParameterStyle: TParamStyle; 
                 out ParamBinding: TParamBinding; 
                 out ReplaceString: string) : string;  overload; overload;

function ParseSQL(const SQL: string; Options: TSQLParseOptions; 
                 ParameterStyle: TParamStyle; 
                 out ParamBinding: TParamBinding; MacroChar: char; 
                 out ReplaceString: string) : string;

    Description

    ParseSQl parses the SQL statement for parameter names in the form :ParamName. It replaces them with a SQL parameter placeholder. If DoCreate is True then a TParam instance is added to the collection with the found parameter name.

    The parameter placeholder is determined by the ParameterStyle property, which can have the following values:

    psInterbase
    Parameters are specified by a ? character.
    psPostgreSQL
    Parameters are specified by a $N character.
    psSimulated
    Parameters are specified by a $N character.

    psInterbase is the default.

    If the EscapeSlash parameter is True, then backslash characters are used to quote the next character in the SQL statement. If it is False, the backslash character is regarded as a normal character.

    If the EscapeRepeat parameter is True (the default) then embedded quotes in string literals are escaped by repeating themselves. If it is false then they should be quoted with backslashes.

    ParamBinding, if specified, is filled with the indexes of the parameter instances in the parameter collection: for each SQL parameter placeholder, the index of the corresponding TParam instance is returned in the array.

    ReplaceString, if specified, contains the placeholder used for the parameter names (by default, $). It has effect only when ParameterStyle equals psSimulated.

    The function returns the SQL statement with the parameter names replaced by placeholders.

    See also

    Name Description
    TParam Parameter description class.
    TParam.Name Name of the parameter.
    TParamStyle Style of parameter.