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

#import <ZIMSqlAlterTableStatement.h>

Inheritance diagram for ZIMSqlAlterTableStatement:
<ZIMSqlStatement> <ZIMSqlDataDefinitionCommand>

List of all members.

Public Member Functions

(id) - initWithXmlSchema:withChanges:error:
(id) - init
(void) - table:
(void) - autoincrement:
(void) - column:type:
(void) - column:type:defaultValue:
(void) - column:type:primaryKey:
(void) - column:type:unique:
(void) - rename:
(NSString *) - statement
(void) - parser:didStartElement:namespaceURI:qualifiedName:attributes: [implementation]
(void) - parser:didEndElement:namespaceURI:qualifiedName: [implementation]
(void) - parser:parseErrorOccurred: [implementation]
(void) - load [implementation]

Protected Attributes

NSString_table
NSString_clause
NSMutableDictionary * _schema
NSMutableArray * _stack
NSUInteger _counter
NSError * _error

Detailed Description

Discussion:
This class represents an SQL alter table statement.
Updated:
2012-03-18
See also:
http://www.sqlite.org/lang_altertable.html

Member Function Documentation

- (void) autoincrement: (NSUInteger)  position
Signature:
autoincrement:
Discussion:
This method will change the autoincrement position. WARNING: ALTERING TABLE VIA THIS METHOD MAY CAUSE PROBLEMS WITH THE AUTOINCREMENT KEY GENERATION ALGORITHM.
Parameters:
positionThe position to which the autoincrementer will be set.
Updated:
2012-03-18
See also:
http://sqlite.org/autoinc.html
http://stackoverflow.com/questions/3443630/reset-the-row-number-count-in-sqlite3-mysql
- (void) column: (NSString *)  column
type: (NSString *)  type 
Signature:
column:type:
Discussion:
This method will create a column with the specified parameters.
Parameters:
columnThe column to be created.
typeThe datatype of the column.
Updated:
2011-10-30
- (void) column: (NSString *)  column
type: (NSString *)  type
defaultValue: (NSString *)  value 
Signature:
column:type:defaultValue:
Discussion:
This method will create a column with the specified parameters.
Parameters:
columnThe column to be created.
typeThe datatype of the column.
valueThe default value to be used when no data is provided.
Updated:
2011-10-30
- (void) column: (NSString *)  column
type: (NSString *)  type
primaryKey: (BOOL)  primaryKey 
Signature:
column:type:primaryKey:
Discussion:
This method will create a column with the specified parameters.
Parameters:
columnThe column to be created.
typeThe datatype of the column.
primaryKeyThis marks the specified column as the primary key.
Updated:
2011-10-30
- (void) column: (NSString *)  column
type: (NSString *)  type
unique: (BOOL)  unique 
Signature:
column:type:unique:
Discussion:
This method will create a column with the specified datatype. It also provides the option to ensure that all values in the column are distinct.
Parameters:
columnThe column to be created.
typeThe datatype of the column.
uniqueThis constrains the column to only unique values.
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 *)  before
withChanges: (NSData *)  after
error: (NSError **)  error 
Signature:
initWithXmlSchema:withChanges:error:
Discussion:
This method initializes the class via an XML file following Ziminji's "XML to DDL" schema.
Parameters:
beforeThe UTF-8 encoded string of XML.
afterThe UTF-8 encoded string of XML with the changes.
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) load [implementation]
- (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]
- (void) rename: (NSString *)  table
Signature:
rename:
Discussion:
This method will set the table used in the SQL statement.
Parameters:
tableThe table that will be used in the SQL statement.
Updated:
2011-10-30
- (NSString *) statement
Signature:
statement
Discussion:
This method will return the SQL statement.
Returns:
The SQL statement that was constructed.
Updated:
2011-10-30

Reimplemented from <ZIMSqlStatement>.

- (void) table: (NSString *)  table
Signature:
table:
Discussion:
This method will set the table used in the SQL statement.
Parameters:
tableThe table that will be used in the SQL statement.
Updated:
2011-10-30

Member Data Documentation

- (NSString*) _clause [protected]
- (NSUInteger) _counter [protected]
- (NSError*) _error [protected]
- (NSMutableDictionary*) _schema [protected]
- (NSMutableArray*) _stack [protected]
- (NSString*) _table [protected]

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