Noebe V2.0 美味的持久层 API 文档 二

 Noebe V2.0 美味的持久层 API 文档 二

Pixysoft.Framework.Noebe.Schema 命名空间概览

 

类概览
ColumnSchema	column schema
DatabaseSchema	database schema
ForeignKeySchema	foreign key schema
PrimaryKeySchema	primary key schema
TableSchema	table schema
UniqueSchema	unique schema

 

结构概览
DataTypeSchema	datatype schema

 

枚举概览
AccessDataTypeCollection
GeneralDataTypeCollection
OracleDataTypeCollection

 

 

Pixysoft.Framework.Noebe.Schema
类 DatabaseSchema

 

属性概览
List<ForeignKeySchema>	ForeignKeys          foreign key schema
NoebeConfiguration	Info          database configuration
List<PrimaryKeySchema>	PrimaryKeys          primary key schema
List<TableSchema>	Tables          tables
List<UniqueSchema>	Uniques          unique schema

 

方法概览
void	Build()          build pointer by name
void	BuildColumns()          build columns
void	BuildForeignKeys()          build foreign key
void	BuildPrimaryKeys()          build primary key
void	BuildUniques()          build unique
Pixysoft.Framework.Noebe.Schema.DatabaseSchema	Clone()          clone
bool	ContainedForeignKey(string fkName)          constain foreign key
bool	ContainedPrimaryKey(string pkName)          contain primary key by constraint name
bool	ContainedTable(string tableName)          contain table by name
bool	ContainedUnique(string constraintName)          contain unique by constraint name
List<ForeignKeySchema>	GetBeingForeignKeys(Pixysoft.Framework.Noebe.Schema.TableSchema table)          get foreign keys which point to this table
List<ForeignKeySchema>	GetBeingForeignKeys(System.Collections.Generic.List`1[[Pixysoft.Framework.Noebe.Schema.ColumnSchema, Pixysoft.Framework.Noebe, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] columns)
List<ForeignKeySchema>	GetBeingForeignKeys(Pixysoft.Framework.Noebe.Schema.ColumnSchema column)          get foreign keys which point to the columns contain this column
List<ForeignKeySchema>	GetBeingForeignKeys(string constraintName)          get foreign key which point to this constraint by name
List<ForeignKeySchema>	GetBeingForeignTableChain(Pixysoft.Framework.Noebe.Schema.TableSchema table)          根据列集合模式，取得被引用关系的所有外键集合，无弱重复 适用于检查有无外键 循环
Pixysoft.Framework.Noebe.Schema.IConstraintSchema	GetConstraint(string constraintName)          get constraint by name (pk or unique)
Pixysoft.Framework.Noebe.Schema.IConstraintSchema	GetConstraint(string tableName, System.Collections.Generic.List`1[[System.String, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] columns)
string	GetDefaultColumnName(Pixysoft.Framework.Noebe.Schema.TableSchema table)          get default column name
string	GetDefaultForeignKeyName(Pixysoft.Framework.Noebe.Schema.TableSchema table)          get default foreign key name
string	GetDefaultPrimaryKeyName(Pixysoft.Framework.Noebe.Schema.TableSchema table)          get default primary key name
string	GetDefaultUniqueName(Pixysoft.Framework.Noebe.Schema.TableSchema table)          get default unique name
Pixysoft.Framework.Noebe.Schema.ForeignKeySchema	GetForeignKey(System.Collections.Generic.List`1[[Pixysoft.Framework.Noebe.Schema.ColumnSchema, Pixysoft.Framework.Noebe, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] columns)
Pixysoft.Framework.Noebe.Schema.ForeignKeySchema	GetForeignKey(string tableName, System.Collections.Generic.List`1[[System.String, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] columns)
Pixysoft.Framework.Noebe.Schema.ForeignKeySchema	GetForeignKeyByName(string fkName)          get foreign key by name
List<ForeignKeySchema>	GetForeignKeyChain(System.Collections.Generic.List`1[[Pixysoft.Framework.Noebe.Schema.ColumnSchema, Pixysoft.Framework.Noebe, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] columns)
List<ForeignKeySchema>	GetForeignKeys(string tableName)          get foreign keys by tablename
List<ForeignKeySchema>	GetForeignKeys(Pixysoft.Framework.Noebe.Schema.TableSchema table)          get foreign keys by tablename
List<ForeignKeySchema>	GetForeignKeys(Pixysoft.Framework.Noebe.Schema.ColumnSchema column)          get foreign key by column which contain column
List<TableSchema>	GetForeignTableChain(Pixysoft.Framework.Noebe.Schema.TableSchema table)          取得外键相连的所有表集合，无弱重复 适用于查看表是否有唯一datatype
Pixysoft.Framework.Noebe.Schema.PrimaryKeySchema	GetPrimaryKey(string tableName)          get primary key by pk tablename
Pixysoft.Framework.Noebe.Schema.PrimaryKeySchema	GetPrimaryKey(Pixysoft.Framework.Noebe.Schema.TableSchema table)          get primary key by pk table
Pixysoft.Framework.Noebe.Schema.PrimaryKeySchema	GetPrimaryKey(string tableName, System.Collections.Generic.List`1[[System.String, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] columns)
Pixysoft.Framework.Noebe.Schema.PrimaryKeySchema	GetPrimaryKey(System.Collections.Generic.List`1[[Pixysoft.Framework.Noebe.Schema.ColumnSchema, Pixysoft.Framework.Noebe, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] columns)
Pixysoft.Framework.Noebe.Schema.PrimaryKeySchema	GetPrimaryKeyByName(string pkName)          get primary key by constraint name
List<ColumnSchema>	GetStrongForeignColumnChain(Pixysoft.Framework.Noebe.Schema.ColumnSchema column)          取得外键相连的所有列集合，无弱重复 适用于修改datatype
Pixysoft.Framework.Noebe.Schema.TableSchema	GetTable(string tableName)          get table by name
Pixysoft.Framework.Noebe.Schema.UniqueSchema	GetUnique(System.Collections.Generic.List`1[[Pixysoft.Framework.Noebe.Schema.ColumnSchema, Pixysoft.Framework.Noebe, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] columns)
Pixysoft.Framework.Noebe.Schema.UniqueSchema	GetUnique(string tableName, System.Collections.Generic.List`1[[System.String, mscorlib, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]] columns)
Pixysoft.Framework.Noebe.Schema.UniqueSchema	GetUniqueByName(string constraintName)          get unique by constraint name
List<UniqueSchema>	GetUniques(string tableName)          get unique by tablename
List<UniqueSchema>	GetUniques(Pixysoft.Framework.Noebe.Schema.TableSchema table)          get unique by table
List<UniqueSchema>	GetUniques(Pixysoft.Framework.Noebe.Schema.ColumnSchema column)          get uniques by column which contain this column
bool	HasConstraint(string constraintName)          whether constraintname is a constraint
bool	HasForeignKey(Pixysoft.Framework.Noebe.Schema.TableSchema table)          whether table has foreign key
bool	HasPrimaryKey(Pixysoft.Framework.Noebe.Schema.TableSchema table)          whether table has primary key
bool	HasUnique(Pixysoft.Framework.Noebe.Schema.TableSchema table)          whether table has unique constraint
void	Inspection()          check database
bool	IsBeingForeignKey(System.Collections.Generic.List`1[[Pixysoft.Framework.Noebe.Schema.ColumnSchema, Pixysoft.Framework.Noebe, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] columns)
bool	IsBeingForeignKey(string constraintName)          whether foreign key point to this constraint name
bool	IsForeignKey(System.Collections.Generic.List`1[[Pixysoft.Framework.Noebe.Schema.ColumnSchema, Pixysoft.Framework.Noebe, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] columns)
bool	IsForeignKey(string fkName)          whether fkname is foreign key
bool	IsPrimaryKey(System.Collections.Generic.List`1[[Pixysoft.Framework.Noebe.Schema.ColumnSchema, Pixysoft.Framework.Noebe, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] columns)
bool	IsPrimaryKey(Pixysoft.Framework.Noebe.Schema.ColumnSchema column)          whether column is in one of primary key
bool	IsUnique(System.Collections.Generic.List`1[[Pixysoft.Framework.Noebe.Schema.ColumnSchema, Pixysoft.Framework.Noebe, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]] columns)
void	Refresh()          refresh name by pointer
void	RefreshColumns()          referesh columns
void	RefreshForeignKeys()          refresh foreign key
void	RefreshPrimaryKeys()          refresh primary key
void	RefreshUniques()          refresh unique
void	RemoveTable(Pixysoft.Framework.Noebe.Schema.TableSchema table)          remove table
void	RemoveTable(string tableName)          remove table by name
string	ToString()          to string

 

 

Pixysoft.Framework.Noebe.Schema
类 TableSchema

 

属性概览
List<ColumnSchema>	Columns          columns
string	Comment          comment of table
string	TableName          tablename

 

方法概览
void	BuildColumns()          build the column pointer (c++) by columnname
Pixysoft.Framework.Noebe.Schema.TableSchema	Clone()          clone
bool	ContainedColumn(string columnName)          whether contain column by name
Pixysoft.Framework.Noebe.Schema.ColumnSchema	GetColumn(string columnName)          get column by columnname
void	Inspection()          check table schema
void	Refresh()          refresh columnname by column pointer(c++)
string	ToString()          to string

 

 

 

 

Pixysoft.Framework.Noebe.Schema
类 ColumnSchema

 

属性概览
string	ColumnName          column name
string	Comment          column comment
Pixysoft.Framework.Noebe.Schema.DataTypeSchema	DataType          column datatype
string	DefaultValue          column default value
bool	IsNullable          column is nullable
Pixysoft.Framework.Noebe.Schema.TableSchema	Table          the table contains this column
string	TableName          tablename

 

方法概览
Pixysoft.Framework.Noebe.Schema.ColumnSchema	Clone()          clone
void	Inspection()          check schema
string	ToString()          to string

 

 

Pixysoft.Framework.Noebe.Schema
结构 DataTypeSchema

 

属性概览
string	DataType          datatype name
long	Length          varchar length
int	Precision          number precision
int	Scale          number scale

 

方法概览
void	Inspection()          check schema

 

 

Pixysoft.Framework.Noebe.Schema
类 PrimaryKeySchema

 

属性概览
List<String>	ColumnNames          column name
List<ColumnSchema>	Columns          primary key columns
string	ConsName          constraint name
string	IndexName          index name
Pixysoft.Framework.Noebe.Schema.TableSchema	Table          primary key table
string	TableName          table name

 

 

方法概览
Pixysoft.Framework.Noebe.Schema.PrimaryKeySchema	Clone()          clone
void	Inspection()          check primary key schema
void	Refresh()          refresh schema by pointer(c++)
string	ToString()          to string

 

 

Pixysoft.Framework.Noebe.Schema
类 ForeignKeySchema

 

属性概览
string	ConsName          constraint name
List<String>	FkColumnNames          foreign table column name: mdoify tablename add constraint foreign key(columnnames) XXX
List<ColumnSchema>	FkColumns          源列
Pixysoft.Framework.Noebe.Schema.TableSchema	FkTable          源表
string	FkTableName          foreign table name: modify tablename XXX
string	PkeyConsName          目标约束名。references constraint name (unique, index, primarykey)

 

方法概览
Pixysoft.Framework.Noebe.Schema.ForeignKeySchema	Clone()          clone
void	Inspection()          check schema
void	Refresh()          refresh schema by pointer
string	ToString()          to string

 

 

 

Pixysoft.Framework.Noebe.Schema
类 UniqueSchema

 

属性概览
List<String>	ColumnNames
List<ColumnSchema>	Columns          columns
string	ConsName          constraint name
string	IndexName          index name
Pixysoft.Framework.Noebe.Schema.TableSchema	Table          table
string	TableName          table name

 

方法概览
Pixysoft.Framework.Noebe.Schema.UniqueSchema	Clone()          clone
void	Inspection()          check schema
void	Refresh()          refresh schema by pointer
string	ToString()          to string