Deveel.Data.Database Class Reference

The default implementation of a database in a system. More...

Inheritance diagram for Deveel.Data.Database:

Classes
class	DatabaseTransactionFactory

Public Member Functions
void	Dispose ()
void	Create (string adminName, string adminPassword)
	Creates the database in the context given, granting the administrative control to the user identified by the given name and password. More...
void	Open ()
	Opens the database making it ready to be accessed. More...
void	Close ()
	Closes the database making it not accessible to connections. More...

Package Functions
	Database (DatabaseSystem system, IDatabaseContext context)

Properties
string	Name [get, private set]
	Gets the database name, as configured in the parent context. More...
DatabaseSystem	System [get, private set]
ActiveSessionList	Sessions [get, private set]
Locker	Locker [get, private set]
ITransactionFactory	TransactionFactory [get, private set]
	Gets an object that is used to create new transactions to this database More...
IEventSource IEventSource.	ParentSource [get]
IContext IEventSource.	Context [get]
IEnumerable< KeyValuePair< string, object > > IEventSource.	Metadata [get]
IDatabaseContext	Context [get, private set]
	Gets the context that contains this database. More...
Version	Version [get, private set]
	Gets the version number of this database. More...
bool	Exists [get]
	Gets a boolean value indicating if the database exists within the context given. More...
bool	IsOpen [get, private set]
	Gets a boolean value that indicates if the database was open. More...
TableSourceComposite	TableComposite [get, private set]
ITable	SingleRowTable [get, private set]
	Gets a special table, unique for every database, that has a single row and a single cell. More...
Properties inherited from Deveel.Data.IDatabase
string	Name [get]
	Gets the name of the database. More...
new IDatabaseContext	Context [get]
	Gets the context that contains this database. More...
ITransactionFactory	TransactionFactory [get]
	Gets an object that is used to create new transactions to this database More...
ActiveSessionList	Sessions [get]
	Gets a list of all the open sessions to the database. More...
Locker	Locker [get]
	Gets the objects that is used to lock database objects between transactions. More...
Version	Version [get]
	Gets the version number of this database. More...
bool	Exists [get]
	Gets a boolean value indicating if the database exists within the context given. More...
bool	IsOpen [get]
	Gets a boolean value that indicates if the database was open. More...
ITable	SingleRowTable [get]
	Gets a special table, unique for every database, that has a single row and a single cell. More...
Properties inherited from Deveel.Data.Diagnostics.IEventSource
IContext	Context [get]
IEventSource	ParentSource [get]
	Gets an optional parent source. More...
IEnumerable< KeyValuePair< string, object > >	Metadata [get]
	Gets the list of metadata associated to the source. More...

Private Member Functions
	~Database ()
	Finalizes an instance of the Database class. More...
void	DiscoverDataVersion ()
void	Dispose (bool disposing)
void	OnDatabaseCreate (IQuery context)
void	SetCurrentDataVersion (IQuery context)
void	CreateSchemata (IQuery context)
void	AssertDataVersion ()

Private Attributes
bool	disposed

Detailed Description

The default implementation of a database in a system.

This class implements the IDatabase contract, that is backed by a IDatabaseContext for configurations and services, provides functionalities for the management of data in the relational model.

Definition at line 38 of file Database.cs.

Constructor & Destructor Documentation

Deveel.Data.Database.Database ( DatabaseSystem  system, IDatabaseContext  context  )

inlinepackage

Definition at line 39 of file Database.cs.

                                                                           {
            System = system;
            Context = context;

            Name = Context.DatabaseName();

            DiscoverDataVersion();

            TableComposite = new TableSourceComposite(this);

            Context.RegisterInstance(this);
            Context.RegisterInstance<ITableSourceComposite>(TableComposite);

            Locker = new Locker(this);

            Sessions = new ActiveSessionList(this);

            // Create the single row table
            var t = new TemporaryTable(context, "SINGLE_ROW_TABLE", new ColumnInfo[0]);
            t.NewRow();
            SingleRowTable = t;

            TransactionFactory = new DatabaseTransactionFactory(this);
        }

Deveel.Data.Database.~Database ( )

inlineprivate

Finalizes an instance of the Database class.

Definition at line 67 of file Database.cs.

                    {
            Dispose(false);
        }

Member Function Documentation

void Deveel.Data.Database.AssertDataVersion ( )

inlineprivate

Definition at line 362 of file Database.cs.

                                         {
            // TODO:
        }

void Deveel.Data.Database.Close ( )

inline

Closes the database making it not accessible to connections.

Exceptions

DatabaseSystemException

The database is not initialized. or An error occurred during database shutdown.

Typical implementations of this interface will automatically invoke the closure of the database on disposal (IDisposable.Dispose.

Implements Deveel.Data.IDatabase.

Definition at line 378 of file Database.cs.

                            {
            if (!IsOpen)
                throw new DatabaseSystemException("The database is not initialized.");

            try {
                if (Context.DeleteOnClose()) {
                    // Delete the tables if the database is set to delete on
                    // shutdown.
                    TableComposite.Delete();
                } else {
                    // Otherwise close the conglomerate.
                    TableComposite.Close();
                }
            } catch (DatabaseSystemException) {
                throw;
            } catch (Exception e) {
                throw new DatabaseSystemException("An error occurred during database shutdown.", e);
            } finally {
                IsOpen = false;
            }
        }

void Deveel.Data.Database.Create ( string  adminName, string  adminPassword  )

inline

Creates the database in the context given, granting the administrative control to the user identified by the given name and password.

Parameters

adminName	The name of the administrator.
adminPassword	The password used to identify the administrator.

Exceptions

DatabaseSystemException	If the database context is configured to be in read-only model, if it was not possible to commit the initial information or if another unhanded error occurred while creating the database.
ArgumentNullException	If either one of adminName or adminPassword are null or empty.

The properties used to create the database are extracted from the underlying context (DatabaseContext).

This method does not automatically open the database: to make it accessible a call to Open is required.

See also

IDatabaseContext.Configuration

Implements Deveel.Data.IDatabase.

Definition at line 240 of file Database.cs.

                                                                   {
            if (Context.ReadOnly())
                throw new DatabaseSystemException("Cannot create database in read-only mode.");

            if (String.IsNullOrEmpty(adminName))
                throw new ArgumentNullException("adminName");
            if (String.IsNullOrEmpty(adminPassword))
                throw new ArgumentNullException("adminPassword");

            try {
                // Create the conglomerate
                TableComposite.Create();

                using (var session = this.CreateInitialSystemSession()) {
                    using (var context = session.CreateQuery()) {
                        try {
                            session.CurrentSchema(SystemSchema.Name);

                            // Create the schema information tables
                            CreateSchemata(context);

                            // The system tables that are present in every conglomerate.
                            SystemSchema.CreateTables(context);
                            SystemGroups.Create(context);

                            context.CreatePublicUser();

                            // Create the system views
                            InformationSchema.CreateViews(context);
                            InformationSchema.GrantToPublic(context);

                            this.CreateAdminUser(context, adminName, adminPassword);

                            SetCurrentDataVersion(context);

                            // Set all default system procedures.
                            // TODO: SystemSchema.SetupSystemFunctions(session, username);

                            OnDatabaseCreate(context);

                            try {
                                // Close and commit this transaction.
                                session.Commit();
                            } catch (TransactionException e) {
                                throw new DatabaseSystemException("Could not commit the initial information", e);
                            }
                        } catch (DatabaseSystemException) {
                            throw;
                        } catch (Exception ex) {
                            throw new DatabaseSystemException("An error occurred while creating the database.", ex);
                        }
                    }
                }

                // Close the conglomerate.
                TableComposite.Close();
            } catch (DatabaseSystemException) {
                throw;
            } catch (Exception e) {
                throw new DatabaseSystemException("An error occurred while creating the database.", e);
            }
        }

void Deveel.Data.Database.CreateSchemata ( IQuery  context )

inlineprivate

Definition at line 307 of file Database.cs.

                                                    {
            try {
                context.CreateSchema(InformationSchema.SchemaName, SchemaTypes.System);
                context.CreateSchema(Context.DefaultSchema(), SchemaTypes.Default);
            } catch (DatabaseSystemException) {
                throw;
            } catch (Exception ex) {
                throw new DatabaseSystemException("Unable to create the default schema for the database.", ex);
            }
        }

void Deveel.Data.Database.DiscoverDataVersion ( )

inlineprivate

Definition at line 108 of file Database.cs.

                                           {
            var dataVerion = Attribute.GetCustomAttribute(typeof (Database).Assembly, typeof (DataVersionAttribute))
                as DataVersionAttribute;
            if (dataVerion != null)
                Version = dataVerion.Version;
        }

void Deveel.Data.Database.Dispose ( )

inline

Definition at line 115 of file Database.cs.

                              {
            Dispose(true);
            GC.SuppressFinalize(this);
        }

void Deveel.Data.Database.Dispose ( bool  disposing )

inlineprivate

Definition at line 122 of file Database.cs.

                                             {
            if (!disposed) {
                if (disposing) {
                    if (IsOpen) {
                        // TODO: Report the error
                    }

                    if (Locker != null)
                        Locker.Reset();

                    if (TableComposite != null)
                        TableComposite.Dispose();

                    if (Context != null)
                        Context.Dispose();

                    if (System != null)
                        System.RemoveDatabase(this);
                }

                Locker = null;
                System = null;
                TableComposite = null;
                Context = null;
                disposed = true;
            }
        }

void Deveel.Data.Database.OnDatabaseCreate ( IQuery  context )

inlineprivate

Definition at line 200 of file Database.cs.

                                                      {
            var callbacks = Context.ResolveAllServices<IDatabaseCreateCallback>();
            if (callbacks != null) {
                foreach (var callback in callbacks) {
                    try {
                        if (callback != null)
                            callback.OnDatabaseCreate(context);
                    } catch (Exception) {
                        //TODO: Route an error event to the listeners
                    }
                }
            }
        }

void Deveel.Data.Database.Open ( )

inline

Opens the database making it ready to be accessed.

Exceptions

DatabaseSystemException

The database was already initialized. or or An error occurred when initializing the database.

This method ensures the system components and the data are ready to allow any connection to be established.

After this method successfully exists, the state of IsOpen is changed to true.

Implements Deveel.Data.IDatabase.

Definition at line 337 of file Database.cs.

                           {
            if (IsOpen)
                throw new DatabaseSystemException("The database was already initialized.");

            try {
                // Check if the state file exists.  If it doesn't, we need to report
                // incorrect version.
                if (!TableComposite.Exists())
                    // If neither store or state file exist, assume database doesn't
                    // exist.
                    throw new DatabaseSystemException(String.Format("The database {0} does not exist.", Name));

                // Open the conglomerate
                TableComposite.Open();

                AssertDataVersion();
            } catch (DatabaseSystemException) {
                throw;
            } catch (Exception e) {
                throw new DatabaseSystemException("An error occurred when initializing the database.", e);
            }

            IsOpen = true;
        }

void Deveel.Data.Database.SetCurrentDataVersion ( IQuery  context )

inlineprivate

Definition at line 303 of file Database.cs.

                                                           {
            // TODO: Get the data version and then set it to the database table 'vars'
        }

Member Data Documentation

bool Deveel.Data.Database.disposed

private

Definition at line 120 of file Database.cs.

Property Documentation

IContext IEventSource. Deveel.Data.Database.Context

getprivate

Definition at line 95 of file Database.cs.

IDatabaseContext Deveel.Data.Database.Context

getprivate set

Gets the context that contains this database.

See also

IDatabaseContext

Definition at line 154 of file Database.cs.

bool Deveel.Data.Database.Exists

get

Gets a boolean value indicating if the database exists within the context given.

Exceptions

Exception

An error occurred while testing database existence.

See also

Create

Definition at line 171 of file Database.cs.

bool Deveel.Data.Database.IsOpen

getprivate set

Gets a boolean value that indicates if the database was open.

See also

Open, Close

Definition at line 190 of file Database.cs.

Locker Deveel.Data.Database.Locker

getprivate set

Definition at line 83 of file Database.cs.

IEnumerable<KeyValuePair<string, object> > IEventSource. Deveel.Data.Database.Metadata

getprivate

Definition at line 99 of file Database.cs.

string Deveel.Data.Database.Name

getprivate set

Gets the database name, as configured in the parent context.

The database name.

Definition at line 77 of file Database.cs.

IEventSource IEventSource. Deveel.Data.Database.ParentSource

getprivate

Definition at line 91 of file Database.cs.

ActiveSessionList Deveel.Data.Database.Sessions

getprivate set

Definition at line 81 of file Database.cs.

ITable Deveel.Data.Database.SingleRowTable

getprivate set

Gets a special table, unique for every database, that has a single row and a single cell.

Definition at line 198 of file Database.cs.

DatabaseSystem Deveel.Data.Database.System

getprivate set

Definition at line 79 of file Database.cs.

TableSourceComposite Deveel.Data.Database.TableComposite

getprivate setpackage

Definition at line 192 of file Database.cs.

ITransactionFactory Deveel.Data.Database.TransactionFactory

getprivate set

Gets an object that is used to create new transactions to this database

See also

ITransactionFactory

Definition at line 89 of file Database.cs.

Version Deveel.Data.Database.Version

getprivate set

Gets the version number of this database.

This value is useful for data compatibility between versions of the system.

Definition at line 163 of file Database.cs.

---

The documentation for this class was generated from the following file:

• /var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data/Database.cs