DocDB Class Reference

The <class>SYSTEM.DocDB</class> class provides an interface for managing Document Databases. More...

Inheritance diagram for DocDB:

Collaboration diagram for DocDB:

Static Public Member Functions
_.DocDB.Database	CreateDatabase (_.Library.String databaseName, _.Library.String documentType, _.Library.String resource)
	The <class>SYSTEM.DocDB</class> class provides an interface for managing Document Databases. More...
_.Library.DynamicArray	DropAllDatabases ()
	Delete all Databases defined in the current namespace and their currently visible extent (user data). More...
_.Library.Boolean	DropDatabase (_.Library.String databaseName)
	Delete the definition and currently visible extent of an existing Database. More...
_.Library.Boolean	Exists (_.Library.RawString databaseName)
_.Library.DynamicArray	GetAllDatabases ()
	Return an array (<class>Library.DynamicArray</class>) containing the names of all Databases defined in the current namespace.
_.DocDB.Database	GetDatabase (_.Library.String databaseName)
	Retrieve the Database definition, this includes the Name, Class, Resource and Document Type Class. More...
Static Public Member Functions inherited from Help
_.Library.String	Help (_.Library.String method)
	This is a helper class that is used by the various SYSTEM classes to provide a Help method. More...

Detailed Description

The <class>SYSTEM.DocDB</class> class provides an interface for managing Document Databases.

You can use it via the special $SYSTEM object:

You can call help to get a list of all entry points:

    do $SYSTEM.DocDB.Help()
    

Member Function Documentation

CreateDatabase()

_.DocDB.Database CreateDatabase ( _.Library.String  databaseName, _.Library.String  documentType, _.Library.String  resource  )

static

The <class>SYSTEM.DocDB</class> class provides an interface for managing Document Databases.

You can use it via the special $SYSTEM object:

You can call help to get a list of all entry points:

    do $SYSTEM.DocDB.Help()
    

Create a new Database in the current namespace. If a Database of that name already exists then return an error.

Accepts Database Name, Document Type, and Resource. Return value is an oref referencing the Database definition object.

DropAllDatabases()

_.Library.DynamicArray DropAllDatabases ( )

static

Delete all Databases defined in the current namespace and their currently visible extent (user data).

Returns an array containing

the names of all Databases successfully dropped.

DropDatabase()

_.Library.Boolean DropDatabase ( _.Library.String  databaseName )

static

Delete the definition and currently visible extent of an existing Database.

Return true if the Database exists and the drop is successful,

false if the named Database does not exist. If an error is encountered during execution then an exception is thrown.

Exists()

_.Library.Boolean Exists ( _.Library.RawString  databaseName )

static

Return 1 (true) if the databaseName database is defined in the current namespace, 0 (false) otherwise.

GetDatabase()

_.DocDB.Database GetDatabase ( _.Library.String  databaseName )

static

Retrieve the Database definition, this includes the Name, Class, Resource and Document Type Class.

If the requested Database does not exist then an exception is thrown.

Returns an oref referencing the Database definition object.