Accessing database properties

The following table lists the NotesDatabase properties:

Property

Data type

Description

ACL

NotesACL

(Read-only) Access control list for a database

ACLActivityLog

String array

(Read-only) Log from the access control list

Agents

NotesAgent array

(Read-only) Agents in a database

AllDocuments

NotesDocumentCollection

(Read-only) All the documents in a database

Categories

String

(Read-write) Categories under which a database appears in a database catalog

Created

Date/Time

(Read-only) Date and time a database was created

CurrentAccessLevel

Integer

(Read-only) User's access level to a database

DelayUpdates

Boolean

(Read-write) True will delay (batch) server input/output for better performance

DesignTemplateName

String

(Read-only) Database design template, if any

FileFormat

Integer

(Read-only) Database ODS (on-disk structure) version

FileName

String

(Read-only) Database file name

FilePath

String

(Read-only) Database file path

FolderReferencesEnabled

Boolean

(Read-write) Determines what folders, if any, a document is in

Forms

NotesForm array

(Read-only) Forms in a database

FTIndexFrequency

Integer constant

(Read-write) Update frequency of a database's full-text index

HttpURL

String

(Read-only) The HTTP URL of a database.

IsClusterReplication

Boolean

(Read-write) True if cluster replication is in effect for a database on a server in a cluster.

IsConfigurationDirectory

Boolean

(Read-only) Indicates if a database is a Configuration Directory database

IsCurrentAccessPublicReader

Boolean

(Read-only) Indicates if the current user has public reader access in a database

IsCurrentAccessPublicWriter

Boolean

(Read-only) Indicates if the current user has public writer access in a database

IsDesignLockingEnabled

Boolean

(Read-write) Indicates if design elements can be locked.

IsDocumentLockingEnabled

Boolean

(Read-write) Indicates if documents can be locked.

IsDirectoryCatalog

Boolean

(Read-only) Indicates if a database is a Directory Catalog database

IsFTIndexed

Boolean

(Read-only) True if a database is full-text indexed

IsInMultiDbIndexing

Boolean

(Read-write) True if a database is set for "Include in multi-database indexing"

IsInService

Boolean

(Read-write) True if a database on a server on a cluster is accessible

IsLink

Boolean

(Read-only) True if a database is the target of a link

IsMultiDbSearch

Boolean

(Read-only) True if the search index is multi-database

IsOpen

Boolean

(Read-only) True if a database is open

IsPendingDelete

Boolean

(Read-only) True if a database on a server in a cluster is marked for deletion.

IsPrivateAddressBook

Boolean

(Read-only) True if a database is a Personal Address Book; only valid through AddressBooks in NotesSession

IsPublicAddressBook

Boolean

(Read-only) True if a database is a Domino® Directory; only valid through AddressBooks in NotesSession

LastFixup

Date/Time

(Read-only) Date and time that a database was last checked by the Fixup task

LastFTIndexed

Date/Time

(Read-only) Date and time a full-text index, if any, was last updated

LastModified

Date/Time

(Read-only) Date and time a database was last modified

LimitRevisions

Double

(Read-write) Maximum number of entries allowed in $Revisions field

LimitUpdatedBy

Double

(Read-write) Maximum number of entries allowed in $UpdatedBy field

ListInDbCatalog

Double

(Read-write) True if a database appears in database catalogs

Managers

String array

(Read-only) Users that have Manager access to a database

MaxSize

Double

(Read-only) Shows the maximum size assigned to a database

NotesURL

String

(Read-only) The Notes® URL of a database.

Parent

NotesSession

(Read-only) Session that contains a database

PercentUsed

Double

(Read-only) Percent of the total size of a database that is occupied by real data

ReplicaID

String

(Read-only) Database replica ID in hexadecimal

ReplicationInfo

NotesReplication

(Read-only) Provides access to a NotesReplication object

Server

String

(Read-only) Name of the server containing a database

Size

Double

(Read-only) Database size, in bytes

SizeQuota

Long

(Read-write) Database size quota, if any; you must be an administrator to write

SizeWarning

Integer

(Read-write) The size warning threshold of a database, in kilobytes; you must be an administrator to write

TemplateName

String

(Read-only) Database template name, if database is a template

Title

String

(Read-write) Database title

Type

Integer constant

(Read-only) Database type

UndeleteExpireTime

Integer

(Read-write) Expiration time for soft deletions in hours

UnprocessedDocuments

NotesDocumentCollection

(Read-only) All documents not yet processed in agent or view

Views

NotesView array

(Read-only) Named views in a database

For further details on accessing the properties and methods of a database, see the Usage section in the NotesDatabase class topic.

Use Fixup to run the Fixup task on a database.

Use CreateFTIndex and RemoveFTIndex to create and remove full-text indexes.

Use GetOption and SetOption to get and set database options.