Arena
1.0
A content management system
|
A query executed against a MySQL data source. More...
Public Member Functions | |
def | __init__ |
Constructor. | |
def | init |
Initializer. | |
def | __del__ |
Destructor. | |
def | execute |
Execute the query. | |
def | nextRecord |
Retrieve the next row from the query. More... | |
def | escapeString |
Escape special characters in the specified string so that it is safe for use with an SQL query. More... | |
def | quoteString |
Return the quoted form of the specified string, such that it is suitable for use with an SQL query. More... | |
def | quoteIdentifier |
Return the specified identifier, delimited with the special quotes used by the data source for identifiers. More... | |
def | implodeIdentifiersInSortCriteria |
Implode identifiers in sort criteria, expanding sort order specifiers where given, and ensuring that identifiers are quoted properly. More... | |
Public Member Functions inherited from Plugins.DataSource.SQLQueries.AnSQLQuery | |
def | __init__ |
Construct a new query instance that will operate on the specified data source. More... | |
def | init |
Initializer. | |
def | escapeString |
Escape special characters in the specified string so that it is safe for use with an SQL query. More... | |
def | quoteString |
Return the quoted form of the specified string, such that it is suitable for use with an SQL query. More... | |
def | processFormatValue |
Process a value contained within a format string. More... | |
def | formatString |
Format a query string for use with the data source. More... | |
def | quoteIdentifier |
Return the specified identifier, delimited with the special quotes used by the data source for identifiers. More... | |
def | implodeIdentifiersIn |
Implode the identifiers contained in the specified list, placing database-specific quotation marks around each one. More... | |
def | implodeValuesIn |
Implode the values in the specified list, escaping any string values that are found. More... | |
def | implodeFieldsIn |
Implode the fields and values in the specified dictionary object, quoting identifiers and escaping fields as appropriate. More... | |
def | processCriterionPlaceholder |
Process a placeholder from a criterion format string. More... | |
def | implodeCriteriaIn |
Implode the fields and values in the specified criteria list, quoting the identifiers and escaping (and quoting) the string values. More... | |
def | prepareQueryString |
Prepare the query string for submission to the data source. More... | |
def | toString |
Construct a string representation of the data source. More... | |
def | queryString |
Return the string used by the query. More... | |
Public Member Functions inherited from Library.DataSource.Queries.AQuery | |
def | __init__ |
Construct a new query instance that will operate on the specified data source. More... | |
def | init |
Initializer. | |
def | __del__ |
Destroy the query instance. More... | |
def | execute |
Execute the query. More... | |
def | nextRecord |
Retrieve the next row from the query. More... | |
def | recordCount |
Retrieve the number of rows affected or returned by the query. More... | |
def | Rows |
Return an iterator for the query that retrieves rows as instances of the specified row class. More... | |
def | __iter__ |
Return an iterator for the query. More... | |
def | __len__ |
Retrieve the "length" of the query – the number of rows returned. More... | |
Public Member Functions inherited from Library.DataSource.Databases.ADataOperation | |
def | __init__ |
Construct a new data operation that will operate on the specified data source. More... | |
def | init |
Initializer. | |
def | execute |
Execute the operation. More... | |
def | Source |
Retrieve the data source used by the operation. More... | |
def | handle |
Retrieve the handle assigned to the operation by the data source. More... | |
def | runtime |
Retrieve the amount of time elapsed while executing the operation. More... | |
def | result |
Retrieve the result code returned by the data source after executing the operation. More... | |
def | message |
Retrieve the message generated by the data source while executing the operation, if any. More... | |
Public Member Functions inherited from Library.Base.Events.ALoggingEventfulObject | |
def | __init__ |
Constructor. More... | |
def | init |
Initializer. | |
def | error |
Generate an error event. More... | |
def | log |
Log the specified item. More... | |
def | Log |
Retrieve the log used by the class. | |
Public Member Functions inherited from Library.Base.Events.AnEventfulObject | |
def | __init__ |
Constructor. More... | |
def | init |
Initializer. | |
def | __del__ |
Destructor. | |
def | parseParams |
Parse the specified parameters, looking for named events and setting event handlers as appropriate. More... | |
def | generate |
Generate the named event. | |
def | update |
Update the events generated by the object. | |
def | error |
Generate an error event. More... | |
def | toString |
Construct a string representation of the object. More... | |
def | on |
Set the handler for the specified event. More... | |
def | onMultiple |
Set handlers for multiple events. More... | |
def | handlerFor |
Retrieve the handler for the specified event. More... | |
def | generates |
Determine whether or not the object generates the named event. More... | |
def | __getitem__ |
Retrieve the value of the named property. | |
def | __setitem__ |
Set the value of the named property. | |
Public Member Functions inherited from Library.Base.Classwork.AnObject | |
def | init |
Initialize a new object instance. More... | |
def | __init__ |
Construct and initialize a new instance of AnObject. More... | |
def | __del__ |
Destroy the object instance. More... | |
def | displayName |
Construct a "pretty" display name for the class instance, based on the name of its class. More... | |
def | implements |
Determine whether the class instance is related to the specified class. More... | |
def | toString |
Return a string representation of the class, suitable for output to a console or text-based device. More... | |
def | __str__ |
Return a string representation of the class. More... | |
def | classname |
Return the name of the class from which the instance was created. More... | |
def | name |
Return the name of the class. More... | |
Public Member Functions inherited from Library.String.Utilities.IsPrintable | |
def | toString |
Return a string representation of the class conveniently. More... | |
def | __str__ |
Return a string representation of the class. More... | |
def | printTo |
Print a string representation of the class to the specified stream. More... | |
A query executed against a MySQL data source.
def Plugins.DataSource.MySQL.Queries.AMySQLQuery.escapeString | ( | Self, | |
thisString | |||
) |
Escape special characters in the specified string so that it is safe for use with an SQL query.
This routine calls String.escape with #myqSpecialCharacters.
def Plugins.DataSource.MySQL.Queries.AMySQLQuery.implodeIdentifiersInSortCriteria | ( | Self, | |
thisList, | |||
itemsDelimiter = myqListDelimiter |
|||
) |
Implode identifiers in sort criteria, expanding sort order specifiers where given, and ensuring that identifiers are quoted properly.
def Plugins.DataSource.MySQL.Queries.AMySQLQuery.nextRecord | ( | Self, | |
RowClass = None , |
|||
params | |||
) |
Retrieve the next row from the query.
def Plugins.DataSource.MySQL.Queries.AMySQLQuery.quoteIdentifier | ( | Self, | |
thisIdentifier | |||
) |
Return the specified identifier, delimited with the special quotes used by the data source for identifiers.
If the data source for which the query is meant to be use does not use special quote characters, this routine should simply return the identifier string, unchanged.
def Plugins.DataSource.MySQL.Queries.AMySQLQuery.quoteString | ( | Self, | |
thisString | |||
) |
Return the quoted form of the specified string, such that it is suitable for use with an SQL query.
This routine calls String.quote() with #myqQuoteCharacter.