window.runtime propertywindow.runtime.flash.data.SQLColumnSchema
InheritanceSQLColumnSchema Inheritance Object

The SQLColumnSchema class provides information describing the characteristics of a specific column within a table in a database.

To obtain column schema information for one or more tables in a database, use the SQLConnection.loadSchema() method to load the schema information, making certain to use true for the includeColumnSchema argument's value. In the resulting SQLSchemaResult instance, each table and view definition will include a columns property — an array of SQLColumnSchema instances representing the columns in the table or view.

Generally, developer code does not construct SQLColumnSchema instances directly.

See also

SQLConnection.loadSchema()
SQLTableSchema
SQLViewSchema


Properties
 PropertyDefined By
  allowNull : Boolean
[read-only] Indicates whether NULL values are allowed in this column.
SQLColumnSchema
  autoIncrement : Boolean
[read-only] Indicates whether this is an auto-increment column.
SQLColumnSchema
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  dataType : String
[read-only] Gets the data type of the column as a string.
SQLColumnSchema
  defaultCollationType : String
[read-only] Indicates the default collation sequence that is defined for this column.
SQLColumnSchema
  name : String
[read-only] Gets the name of the column.
SQLColumnSchema
  primaryKey : Boolean
[read-only] Indicates whether this column is the primary key column (or one of the primary key columns in a composite key) for its associated table.
SQLColumnSchema
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
Public Methods
 MethodDefined By
  
SQLColumnSchema(name:String, primaryKey:Boolean, allowNull:Boolean, autoIncrement:Boolean, dataType:String, defaultCollationType:String)
Constructs a SQLColumnSchema instance.
SQLColumnSchema
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Property Detail
allowNullproperty
allowNull:Boolean  [read-only]

Indicates whether NULL values are allowed in this column. A column that is declared with a NOT NULL constraint will have a false value for the allowNull property.


autoIncrementproperty 
autoIncrement:Boolean  [read-only]

Indicates whether this is an auto-increment column. An auto-increment column is a special type of PRIMARY KEY column whose value is automatically generated as the next value in a sequence of integers when a new row is inserted into the table.


dataTypeproperty 
dataType:String  [read-only]

Gets the data type of the column as a string. The value is the literal data type name that was specified in the CREATE TABLE statement that was used to define the table, or null if no data type was specified.


defaultCollationTypeproperty 
defaultCollationType:String  [read-only]

Indicates the default collation sequence that is defined for this column. The value of this property corresponds to one of the constants in the SQLCollationType class:


See also

nameproperty 
name:String  [read-only]

Gets the name of the column.


primaryKeyproperty 
primaryKey:Boolean  [read-only]

Indicates whether this column is the primary key column (or one of the primary key columns in a composite key) for its associated table.


Constructor Detail
SQLColumnSchema()Constructor
function SQLColumnSchema(name:String, primaryKey:Boolean, allowNull:Boolean, autoIncrement:Boolean, dataType:String, defaultCollationType:String)

Constructs a SQLColumnSchema instance. Generally, developer code does not call the SQLColumnSchema constructor directly. To obtain schema information for a database, call the SQLConnection.loadSchema() method.

Parameters
name:String — The name of the column.
 
primaryKey:Boolean — Indicates if this column is a part of the primary key for the associated table.
 
allowNull:Boolean — Indicates if this column can contain NULL values.
 
autoIncrement:Boolean — Indicates if this is an auto increment column.
 
dataType:String — The declared type of the column.
 
defaultCollationType:String — The collation sequence defined for this column. This value corresponds to one of the constants in the SQLCollationType class:
  • SQLCollationType.BINARY indicates that the column uses the BINARY collation sequence.
  • SQLCollationType.NO_CASE indicates that the column uses the NOCASE collation sequence, meaning text comparisons are made in a case-insensitive manner.

See also





 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/labs/air/1/jslr/flash/data/SQLColumnSchema.html