OracleMacroProcessor
Overview
The OracleMacroProcessor class is used to convert Data Abstract macros defined in the Schema statement to Oracle format.
Methods of this class are used by Data Abstract to prepare SQL queries containing macro expressions for execution against Oracle databases.
Consider the following statement:
SELECT
*
FROM
Orders
WHERE
OrderDate > {AddTime(Date(), 2, day)}
It will be converted to:
SELECT
*
FROM
Orders
WHERE
OrderDate > SYSDATE + 2
Location
- Reference: RemObjects.DataAbstract.Server.dll
- Namespace: RemObjects.DataAbstract.Server
- Ancestry: SqlMacroProcessor | OracleMacroProcessor
constructor
Creates a new instance of the OracleMacroProcessor class.
constructor
OracleMacroProcessor()
Sub New()
constructor (String, String, Boolean, ISqlExpressionGenerator) protected (declared in SqlMacroProcessor)
constructor(dateFormat: String; datetimeFormat: String; doubleQuoteStrings: Boolean; expressionGenerator: ISqlExpressionGenerator)
OracleMacroProcessor(String dateFormat, String datetimeFormat, Boolean doubleQuoteStrings, ISqlExpressionGenerator expressionGenerator)
Sub New(dateFormat As String, datetimeFormat As String, doubleQuoteStrings As Boolean, expressionGenerator As ISqlExpressionGenerator)
Parameters:
- dateFormat:
- datetimeFormat:
- doubleQuoteStrings:
- expressionGenerator:
AddVariable (declared in SqlMacroProcessor)
method AddVariable(name: String): SqlMacroVariable
SqlMacroVariable AddVariable(String name)
Function AddVariable(name As String) As SqlMacroVariable
Parameters:
- name:
ClearMacros (declared in SqlMacroProcessor)
method ClearMacros
void ClearMacros()
Sub ClearMacros()
ClearVariables (declared in SqlMacroProcessor)
method ClearVariables
void ClearVariables()
Sub ClearVariables()
CustomMacroHandler (declared in SqlMacroProcessor)
property CustomMacroHandler: SqlMacroCallback read write;
SqlMacroCallback CustomMacroHandler { get; set; }
Property CustomMacroHandler() As SqlMacroCallback
DateFormat protected (declared in SqlMacroProcessor)
Gets the date format for the current database.
property DateFormat: String read;
String DateFormat { get; }
ReadOnly Property DateFormat() As String
DateTimeFormat protected (declared in SqlMacroProcessor)
Gets the datetime format for the current database.
property DateTimeFormat: String read;
String DateTimeFormat { get; }
ReadOnly Property DateTimeFormat() As String
DoubleQuoteStrings protected (declared in SqlMacroProcessor)
Gets the quote string for the date and datetime formats for the current database. If this property is true, the datetime format is represented as "datetime", otherwise as 'datetime'.
property DoubleQuoteStrings: Boolean read;
Boolean DoubleQuoteStrings { get; }
ReadOnly Property DoubleQuoteStrings() As Boolean
EvalToken (declared in SqlMacroProcessor)
method EvalToken(source: String): String
String EvalToken(String source)
Function EvalToken(source As String) As String
Parameters:
- source:
Evaluate (declared in SqlMacroProcessor)
method Evaluate(source: String; delimiter: Char): String
String Evaluate(String source, Char delimiter)
Function Evaluate(source As String, delimiter As Char) As String
Parameters:
- source:
- delimiter:
FindVariable (declared in SqlMacroProcessor)
method FindVariable(name: String): SqlMacroVariable
SqlMacroVariable FindVariable(String name)
Function FindVariable(name As String) As SqlMacroVariable
Parameters:
- name:
GetNewInstance
Returns a new instance of the OracleMacroProcessor class.
method GetNewInstance: ISqlMacroProcessor
ISqlMacroProcessor GetNewInstance()
Function GetNewInstance() As ISqlMacroProcessor
RegisterMacro (declared in SqlMacroProcessor)
method RegisterMacro(macro: SqlMacroProcedure)
void RegisterMacro(SqlMacroProcedure macro)
Sub RegisterMacro(macro As SqlMacroProcedure)
Parameters:
- macro:
RegisterMacros protected (declared in SqlMacroProcessor)
Registers the existing standard macros:
- Date
- DateTime
- AddTime
- FormatDateTime
- FormatDate
- Length
- LowerCase
- UpperCase
- TrimLeft
- TrimRight
- Copy
- NoLock
method RegisterMacros
void RegisterMacros()
Sub RegisterMacros()
Session protected (declared in SqlMacroProcessor)
method Session(sessionValueName: String): String
String Session(String sessionValueName)
Function Session(sessionValueName As String) As String
Parameters:
- sessionValueName:
SqlExpressionGenerator (declared in SqlMacroProcessor)
property SqlExpressionGenerator: ISqlExpressionGenerator read;
ISqlExpressionGenerator SqlExpressionGenerator { get; }
ReadOnly Property SqlExpressionGenerator() As ISqlExpressionGenerator
TrimParametersProvider protected (declared in SqlMacroProcessor)
method TrimParametersProvider(args: IList<String>): IList<String>
IList<String> TrimParametersProvider(IList<String> args)
Function TrimParametersProvider(args As IList<String>) As IList<String>
Parameters:
- args:
CustomMacroHandler (declared in SqlMacroProcessor)
property CustomMacroHandler: SqlMacroCallback read write;
SqlMacroCallback CustomMacroHandler { get; set; }
Property CustomMacroHandler() As SqlMacroCallback
DateFormat protected (declared in SqlMacroProcessor)
Gets the date format for the current database.
property DateFormat: String read;
String DateFormat { get; }
ReadOnly Property DateFormat() As String
DateTimeFormat protected (declared in SqlMacroProcessor)
Gets the datetime format for the current database.
property DateTimeFormat: String read;
String DateTimeFormat { get; }
ReadOnly Property DateTimeFormat() As String
DoubleQuoteStrings protected (declared in SqlMacroProcessor)
Gets the quote string for the date and datetime formats for the current database. If this property is true, the datetime format is represented as "datetime", otherwise as 'datetime'.
property DoubleQuoteStrings: Boolean read;
Boolean DoubleQuoteStrings { get; }
ReadOnly Property DoubleQuoteStrings() As Boolean
SqlExpressionGenerator (declared in SqlMacroProcessor)
property SqlExpressionGenerator: ISqlExpressionGenerator read;
ISqlExpressionGenerator SqlExpressionGenerator { get; }
ReadOnly Property SqlExpressionGenerator() As ISqlExpressionGenerator
constructor
Creates a new instance of the OracleMacroProcessor class.
constructor
OracleMacroProcessor()
Sub New()
constructor (String, String, Boolean, ISqlExpressionGenerator) protected (declared in SqlMacroProcessor)
constructor(dateFormat: String; datetimeFormat: String; doubleQuoteStrings: Boolean; expressionGenerator: ISqlExpressionGenerator)
OracleMacroProcessor(String dateFormat, String datetimeFormat, Boolean doubleQuoteStrings, ISqlExpressionGenerator expressionGenerator)
Sub New(dateFormat As String, datetimeFormat As String, doubleQuoteStrings As Boolean, expressionGenerator As ISqlExpressionGenerator)
Parameters:
- dateFormat:
- datetimeFormat:
- doubleQuoteStrings:
- expressionGenerator:
AddVariable (declared in SqlMacroProcessor)
method AddVariable(name: String): SqlMacroVariable
SqlMacroVariable AddVariable(String name)
Function AddVariable(name As String) As SqlMacroVariable
Parameters:
- name:
ClearMacros (declared in SqlMacroProcessor)
method ClearMacros
void ClearMacros()
Sub ClearMacros()
ClearVariables (declared in SqlMacroProcessor)
method ClearVariables
void ClearVariables()
Sub ClearVariables()
EvalToken (declared in SqlMacroProcessor)
method EvalToken(source: String): String
String EvalToken(String source)
Function EvalToken(source As String) As String
Parameters:
- source:
Evaluate (declared in SqlMacroProcessor)
method Evaluate(source: String; delimiter: Char): String
String Evaluate(String source, Char delimiter)
Function Evaluate(source As String, delimiter As Char) As String
Parameters:
- source:
- delimiter:
FindVariable (declared in SqlMacroProcessor)
method FindVariable(name: String): SqlMacroVariable
SqlMacroVariable FindVariable(String name)
Function FindVariable(name As String) As SqlMacroVariable
Parameters:
- name:
GetNewInstance
Returns a new instance of the OracleMacroProcessor class.
method GetNewInstance: ISqlMacroProcessor
ISqlMacroProcessor GetNewInstance()
Function GetNewInstance() As ISqlMacroProcessor
RegisterMacro (declared in SqlMacroProcessor)
method RegisterMacro(macro: SqlMacroProcedure)
void RegisterMacro(SqlMacroProcedure macro)
Sub RegisterMacro(macro As SqlMacroProcedure)
Parameters:
- macro:
RegisterMacros protected (declared in SqlMacroProcessor)
Registers the existing standard macros:
- Date
- DateTime
- AddTime
- FormatDateTime
- FormatDate
- Length
- LowerCase
- UpperCase
- TrimLeft
- TrimRight
- Copy
- NoLock
method RegisterMacros
void RegisterMacros()
Sub RegisterMacros()
Session protected (declared in SqlMacroProcessor)
method Session(sessionValueName: String): String
String Session(String sessionValueName)
Function Session(sessionValueName As String) As String
Parameters:
- sessionValueName:
TrimParametersProvider protected (declared in SqlMacroProcessor)
method TrimParametersProvider(args: IList<String>): IList<String>
IList<String> TrimParametersProvider(IList<String> args)
Function TrimParametersProvider(args As IList<String>) As IList<String>
Parameters:
- args: