Deveel.Data.IDatabase Interface Reference

The representation of a single database in the system. More...

Inheritance diagram for Deveel.Data.IDatabase:

Public Member Functions
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...

Properties
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...

Detailed Description

The representation of a single database in the system.

A database is an assembly of objects of various kind (schemata, tables, views, types, etc.), organized in a relational model.

Implementations of this contract provide functionalities for

• Assess the status (version

Definition at line 40 of file IDatabase.cs.

Member Function Documentation

void Deveel.Data.IDatabase.Close

(

)

Closes the database making it not accessible to connections.

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

Implemented in Deveel.Data.Database.

void Deveel.Data.IDatabase.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.

Parameters

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

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

Implemented in Deveel.Data.Database.

void Deveel.Data.IDatabase.Open

(

)

Opens the database making it ready to be accessed.

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.

Implemented in Deveel.Data.Database.

Property Documentation

new IDatabaseContext Deveel.Data.IDatabase.Context

get

Gets the context that contains this database.

See also

IDatabaseContext

Definition at line 50 of file IDatabase.cs.

bool Deveel.Data.IDatabase.Exists

get

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

See also

Create

Definition at line 90 of file IDatabase.cs.

bool Deveel.Data.IDatabase.IsOpen

get

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

See also

Open, Close

Definition at line 97 of file IDatabase.cs.

Locker Deveel.Data.IDatabase.Locker

get

Gets the objects that is used to lock database objects between transactions.

The database object locker.

Definition at line 74 of file IDatabase.cs.

string Deveel.Data.IDatabase.Name

get

Gets the name of the database.

Definition at line 44 of file IDatabase.cs.

ActiveSessionList Deveel.Data.IDatabase.Sessions

get

Gets a list of all the open sessions to the database.

The open sessions to the database.

Definition at line 65 of file IDatabase.cs.

ITable Deveel.Data.IDatabase.SingleRowTable

get

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

Definition at line 103 of file IDatabase.cs.

ITransactionFactory Deveel.Data.IDatabase.TransactionFactory

get

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

See also

ITransactionFactory

Definition at line 56 of file IDatabase.cs.

Version Deveel.Data.IDatabase.Version

get

Gets the version number of this database.

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

Definition at line 83 of file IDatabase.cs.

---

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

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