objective-c-sql-query-builder
Public Member Functions | Protected Attributes
ZIMSqlCreateIndexStatement Class Reference

#import <ZIMSqlCreateIndexStatement.h>

Inheritance diagram for ZIMSqlCreateIndexStatement:
<ZIMSqlStatement> <ZIMSqlDataDefinitionCommand>

List of all members.

Public Member Functions

(id) - initWithXmlSchema:error:
(id) - init
(void) - index:on:
(void) - unique:
(void) - column:
(void) - column:descending:
(void) - columns:
(void) - columns:descending:
(NSString *) - statement
(void) - parser:didStartElement:namespaceURI:qualifiedName:attributes: [implementation]
(void) - parser:didEndElement:namespaceURI:qualifiedName: [implementation]
(void) - parser:parseErrorOccurred: [implementation]

Protected Attributes

NSString_index
NSString_table
BOOL _unique
NSMutableSet * _column
NSMutableArray * _stack
NSString_cdata
NSUInteger _counter
NSError * _error

Detailed Description

Discussion:
This class represents an SQL create index statement.
Updated:
2012-03-18
See also:
http://www.sqlite.org/lang_createindex.html

Member Function Documentation

- (void) column: (NSString *)  column
Signature:
column:
Discussion:
This method adds the specified column to be indexed.
Parameters:
columnThe column to be indexed.
Updated:
2011-07-28
- (void) column: (NSString *)  column
descending: (BOOL)  descending 
Signature:
column:descending:
Discussion:
This method adds the specified column to be indexed.
Parameters:
columnThe column to be indexed.
descendingThis will determine whether the column should be ordered in descending order.
Updated:
2011-10-30
- (void) columns: (NSSet *)  columns
Signature:
columns:
Discussion:
This method adds the specified columns to be indexed.
Parameters:
columnsThe columns to be indexed.
Updated:
2011-07-28
- (void) columns: (NSSet *)  columns
descending: (BOOL)  descending 
Signature:
column:descending:
Discussion:
This method adds the specified columns to be indexed.
Parameters:
columnsThe columns to be indexed.
descendingThis will determine whether the column should be ordered in descending order.
Updated:
2011-07-28
- (void) index: (NSString *)  index
on: (NSString *)  table 
Signature:
index:on:
Discussion:
This method defines an index on the specified table.
Parameters:
indexThe index's name.
tableThe table's name.
Updated:
2011-10-30
- (instancetype) init
Signature:
init
Discussion:
This method initializes the class.
Returns:
An instance of this class.
Updated:
2012-03-20
- (instancetype) initWithXmlSchema: (NSData *)  xml
error: (NSError **)  error 
Signature:
initWithXmlSchema:error:
Discussion:
This method initializes the class via an XML file following Ziminji's "XML to DDL" schema.
Parameters:
xmlThe UTF-8 encoded string of XML.
errorUsed when an error occurs while processing the XML data. May be NULL.
Returns:
An instance of this class.
Updated:
2011-10-19
See also:
http://db.apache.org/ddlutils/
http://db.apache.org/ddlutils/schema/
- (void) parser: (NSXMLParser *)  parser
didEndElement: (NSString *)  element
namespaceURI: (NSString *)  namespaceURI
qualifiedName: (NSString *)  qualifiedName 
[implementation]
- (void) parser: (NSXMLParser *)  parser
didStartElement: (NSString *)  element
namespaceURI: (NSString *)  namespaceURI
qualifiedName: (NSString *)  qualifiedName
attributes: (NSDictionary *)  attributes 
[implementation]
- (void) parser: (NSXMLParser *)  parser
parseErrorOccurred: (NSError *)  error 
[implementation]
- (NSString *) statement
Signature:
statement
Discussion:
This method will return the SQL statement.
Returns:
The SQL statement that was constructed.
Updated:
2011-10-19

Reimplemented from <ZIMSqlStatement>.

- (void) unique: (BOOL)  unique
Signature:
unique:
Discussion:
This method establishes whether the index will be unique.
Parameters:
uniqueEstablishes whether the index will be unique.
Updated:
2011-07-09

Member Data Documentation

- (NSString*) _cdata [protected]
- (NSMutableSet*) _column [protected]
- (NSUInteger) _counter [protected]
- (NSError*) _error [protected]
- (NSString*) _index [protected]
- (NSMutableArray*) _stack [protected]
- (NSString*) _table [protected]
- (BOOL) _unique [protected]

The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Properties Defines