SqlQuery MembersA Sandcastle Documented Class Library

The SqlQuery type exposes the following members.
Constructors

  NameDescription
Public methodSqlQuery
SqlQuery constructor.
Back to Top
Methods

  NameDescription
Public methodAddSqlTokenToEnd
Adds a new SqlToken to the end of the query.
Public methodAddSqlTokenToStart
Adds a new SqlToken to the start of the query.
Public methodAppend(SqlQuery)
Append an entire sql query.
Public methodAppend(SqlToken)
Shorter method for appending tokens.
Public methodBuildSql 
Builds an SQL representation of the SqlQuery object with line breaks.
Public methodBuildSql(Boolean)
Builds an SQL representation of the SqlQuery object with optional line breaks.
Public methodBuildSqlNoLineBreaks
Renders the current SqlQuery object to a string that contains a valid SQL query. Enumerates the sqlTokens object and calls BuildSql on each SqlToken node then returns the concatenated results.
Public methodClone
Clone the current SqlQuery object.
Public methodStatic memberCreateFromSerial
Creates a new SqlQuery object from a serialized string.
Public methodFindFirstSqlTokenByClause
Find first token in a clause.
Public methodFindLastSqlTokenByClause
Find last token in a clause.
Public methodFindSqlTokensByClause
Find tokens by clause.
Public methodFindSqlTokensByColumnName
Find tokens by column name.
Public methodFindSqlTokensByGroup
Find tokens by group.
Public methodFindSqlTokensByName
Find tokens by name.
Public methodFindSqlTokensByTableName
Find tokens by table name.
Public methodFindSqlTokensByType
Find tokens by type.
Public methodFromSerial
Set an SqlQuery object from a serialized string.
Public methodGetAllTokens
Returns an array with all the SqlTokens in this query.
Public methodGetAllTokensCloned
Returns a cloned copy of all SqlTokens in this query.
Public methodGetFirstToken
Returns the frist token in the query.
Public methodGetLastToken
Returns the last token in the query.
Public methodGetSerial
Return the last serailized object state if there is one.
Public methodGetSerialLength
Returns the length of the generated serial string.
Public methodGetSql
Returns the last built SQL query.
Public methodGetSqlLength
Returns the length of the generated sql string.
Public methodGetSqlTokenCount
Returns the count of tokens in the query.
Private methodGetTabStr
Returns a string with len \t characters in it.
Public methodGetTokenAt
Returns the token at the given index.
Public methodInsertBeforeLast
Inserts a token before the last token in the token list.
Public methodInsertSqlQueryAfter
Inserts the given SqlQuery object after the target node.
Public methodInsertSqlTokenAfter
Adds a new SqlToken in after an existing LinkedListNode.
Public methodInsertSqlTokenBefore
Adds a new SqlToken in before an existing LinkedListNode.
Public methodNormalizeIndexes
Normalize the index values of the query.
Public methodRemoveFirstToken
Remove the first token from the sql query.
Public methodRemoveLastToken
Remove the last token from the query.
Public methodRemoveToken
Remove the target token from the sql query.
Public methodRemoveTokenAt
Removes a token at the given index.
Public methodSetBracketsAll
Sets the backet visibility settings for all SqlToken objects in the query.
Public methodSetClauseAll
Updates the SqlClause value for the entire query.
Public methodSetEscapeCharsAll
Updates the escape character on all SqlTokens
Public methodSetGroupCharsAll
Updates the grouping character on all SqlTokens.
Public methodSetGroupIndexAll
Sets the group index for all SqlTokens.
Public methodToDetailedString
Returns a string representation of this object's contents.
Public methodToSerial
Convert an SqlQuery object to a serialized string.
Back to Top
Fields

  NameDescription
Private fieldserial
Stores the last serialized version of this object.
Public fieldStatic memberSERIALIZATION_ROW_DELIM
Holds the row serialization string for serializing the SqlToken collection.
Private fieldsql
Stores the last built SQL query.
Private fieldsqlTokens
The main collection of SqlTokens
Private fieldtokenDoesntExistErrMsg
Private string used in exception messages.
Private fieldtokenExistsErrMsg
Private string used in exception messages.
Back to Top
See Also