creole.metadata
[ class tree: creole.metadata ] [ index: creole.metadata ] [ all elements ]
Packages:
creole
creole.common
creole.drivers.mssql
creole.drivers.mssql.metadata
creole.drivers.mysql
creole.drivers.mysql.metadata
creole.drivers.odbc
creole.drivers.odbc.metadata
creole.drivers.oracle
creole.drivers.oracle.metadata
creole.drivers.pgsql
creole.drivers.pgsql.metadata
creole.drivers.sqlite
creole.drivers.sqlite.metadata
creole.metadata
creole.util
creole.util.sql
jargon


Files:
ColumnInfo.php
DatabaseInfo.php
ForeignKeyInfo.php
IndexInfo.php
PrimaryKeyInfo.php
TableInfo.php

Classes:
ColumnInfo
DatabaseInfo
ForeignKeyInfo
IndexInfo
PrimaryKeyInfo
TableInfo

Class: DatabaseInfo

Source Location: /creole/metadata/DatabaseInfo.php

Class Overview




"Info" metadata class for a database.




Author(s):






        
        

Version:


    
  
  • $Revision: 1.11 $
    • 








Variables







Methods















Child classes:






MSSQLDatabaseInfo

	
MSSQL impementation of DatabaseInfo.






MySQLDatabaseInfo

	
MySQL implementation of DatabaseInfo.






ODBCDatabaseInfo

	
ODBC implementation of DatabaseInfo.






OCI8DatabaseInfo

	
Oracle (OCI8) implementation of DatabaseInfo.






PgSQLDatabaseInfo

	
MySQL implementation of DatabaseInfo.






SQLiteDatabaseInfo

	
SQLite implementation of DatabaseInfo.

















Class Details



[line 30]

"Info" metadata class for a database.





Tags:





  

    abstract:  
  

  

    version:  $Revision: 1.11 $
  

  

    author:  Hans Lellelid <hans@xmpl.org>
  










[ Top ]







Class Variables



	
	

	
$conn = 

	
[line 46]

  The database Connection.





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      Connection
    

      

	



	
[ Top ]


	
	

	
$dblink = 

	
[line 55]

  Database link





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      resource
    

      

	



	
[ Top ]


	
	

	
$dbname = 

	
[line 49]

  Database name.





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$seqsLoaded =  false

	
[line 40]

  have sequences been loaded





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$sequences = array()

	
[line 34]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$tables = array()

	
[line 32]

  



Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]


	
	

	
$tablesLoaded =  false

	
[line 37]

  have tables been loaded





Tags:





  

    access:  protected
  






  

	

  

    

      Type:  
      mixed
    

      

	



	
[ Top ]










Class Methods



  

	
	
constructor __construct [line 60]

	

    

    

		DatabaseInfo __construct(
Connection
$conn, Connection
$dbh)
    

    


	
		



Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
OCI8DatabaseInfo::__construct()

		

	

	


        
Parameters:

    

    

          

        Connection  
        $dbh  
        
      

        

    


        
[ Top ]

  

  

	
	
method addTable [line 146]

	

    

    

		void addTable(
TableInfo
$table)
    

    


	
		Adds a table to this db.

Table name is case-insensitive.





Tags:





  

    access:  public
  










        
Parameters:

    

    

          

        TableInfo  
        $table  
        
      

        

    


        
[ Top ]

  

  

	
	
method getConnection [line 111]

	

    

    

		Connection getConnection(
)
    

    


	
		Returns Connection being used.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getName [line 72]

	

    

    

		string getName(
)
    

    


	
		Get name of database.





Tags:





  

    access:  public
  










        
[ Top ]

  

  

	
	
method getSequences [line 183]

	

    

    

		array getSequences(
)
    

    


	
		Gets array of ? objects.





Tags:





  

    return:  ?[]
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method getTable [line 122]

	

    

    

		TableInfo getTable(
string
$name)
    

    


	
		Get the TableInfo object for specified table name.





Tags:





  

    access:  public
  

  

    throws:  SQLException - if table does not exist in this db.
  










        
Parameters:

    

    

          

        string  
        $name  
        The name of the table to retrieve.
      

        

    


        
[ Top ]

  

  

	
	
method getTables [line 135]

	

    

    

		array getTables(
)
    

    


	
		Gets array of TableInfo objects.





Tags:





  

    return:  TableInfo[]
  

  

    access:  public
  










        
[ Top ]

  

  

	
	
method initSequences [line 167]

	

    

    

		void initSequences(
)
    

    


	
		



Tags:





  

    access:  protected
  

  

    abstract:  
  

  

    throws:  SQLException
  









	
Overridden in child classes as:

		

	
MSSQLDatabaseInfo::initSequences()

		

	

		

	
MySQLDatabaseInfo::initSequences()

		
MySQL does not support sequences.

	

		

	
ODBCDatabaseInfo::initSequences()

		

	

		

	
OCI8DatabaseInfo::initSequences()

		
Oracle supports sequences.

	

		

	
PgSQLDatabaseInfo::initSequences()

		
PgSQL sequences.

	

		

	
SQLiteDatabaseInfo::initSequences()

		
SQLite does not support sequences.

	

	


        
[ Top ]

  

  

	
	
method initTables [line 155]

	

    

    

		void initTables(
)
    

    


	
		



Tags:





  

    access:  protected
  

  

    abstract:  
  

  

    throws:  SQLException
  









	
Overridden in child classes as:

		

	
MSSQLDatabaseInfo::initTables()

		

	

		

	
MySQLDatabaseInfo::initTables()

		

	

		

	
ODBCDatabaseInfo::initTables()

		

	

		

	
OCI8DatabaseInfo::initTables()

		

	

		

	
PgSQLDatabaseInfo::initTables()

		

	

		

	
SQLiteDatabaseInfo::initTables()

		

	

	


        
[ Top ]

  

  

	
	
method isSequence [line 173]

	

    

    

		boolean isSequence(
mixed
$key)
    

    


	
		



Tags:





  

    access:  public
  

  

    throws:  SQLException
  










        
[ Top ]

  

  

	
	
method __sleep [line 83]

	

    

    

		array __sleep(
)
    

    


	
		This method is invoked upon serialize().

Because the Info class hierarchy is recursive, we must handle  the serialization and unserialization of this object.





Tags:





  

    return:  The class variables that should be serialized (all must be public!).
  










        
[ Top ]

  

  

	
	
method __wakeup [line 92]

	

    

    

		void __wakeup(
)
    

    


	
		This method is invoked upon unserialize().

This method re-hydrates the object and restores the recursive hierarchy.






        
[ Top ]

  






        

		    

		    Documentation generated on Mon, 23 Aug 2004 21:51:23 -0400 by phpDocumentor 1.3.0RC3