LOTUSSCRIPT/COM/OLE CLASSES


NotesDatabase class
Example

Represents a Notes database.

Containment

Contained by: NotesDbDirectory, NotesSession, and NotesUIDatabase

Contains: NotesACL, NotesAgent, NotesDocument, NotesDocumentCollection, NotesForm, NotesNoteCollection, NotesOutline, NotesReplication, NotesView

Properties

ACL

ACLActivityLog

Agents

AllDocuments

Categories

Created

CurrentAccessLevel

DelayUpdates

DesignTemplateName

FileFormat

FileName

FilePath

FolderReferencesEnabled

Forms

FTIndexFrequency

HttpURL

IsClusterReplication

IsConfigurationDirectory

IsCurrentAccessPublicReader

IsCurrentAccessPublicWriter

IsDesignLockingEnabled

IsDirectoryCatalog

IsDocumentLockingEnabled

IsFTIndexed

IsInMultiDbIndexing

IsInService

IsLink

IsMultiDbSearch

IsOpen

IsPendingDelete

IsPrivateAddressBook

IsPublicAddressBook

LastFixup

LastFTIndexed

LastModified

LimitRevisions

LimitUpdatedBy

ListInDbCatalog

Managers

MaxSize

NotesURL

Parent

PercentUsed

ReplicaID

ReplicationInfo

Server

Size

SizeQuota

SizeWarning

TemplateName

Title

Type

UndeleteExpireTime

UnprocessedDocuments

Views

Methods

Compact

CompactWithOptions

Create

CreateCopy

CreateDocument

CreateFromTemplate

CreateFTIndex

CreateNoteCollection

CreateOutline

CreateReplica

CreateView

EnableFolder

Fixup

FTDomainSearch

FTSearch

FTSearchRange

GetAgent

GetAllReadDocuments

GetAllUnreadDocuments

GetDocumentByID

GetDocumentByUNID

GetDocumentByURL

GetForm

GetModifiedDocuments

GetOption

GetOutline

GetProfileDocCollection

GetProfileDocument

GetURLHeaderInfo

GetView

GrantAccess

MarkForDelete

New

Open

OpenByReplicaID

OpenIfModified

OpenMail

OpenURLDb

OpenWithFailover

QueryAccess

QueryAccessPrivileges

QueryAccessRoles

Remove

RemoveFTIndex

Replicate

RevokeAccess

Search

SetOption

Sign

UnprocessedFTSearch

UnprocessedFTSearchRange

UnprocessedSearch

UpdateFTIndex

Creation and access

There are several ways you can use the NotesDatabase class to access existing databases and to create new ones:


New

Note The New method is not supported in COM.

Creates a NotesDatabase object that represents the database located at the server and file name you specify, and opens the database, if possible. Unlike the behavior of New in other classes (such as NotesDocument), using New for a NotesDatabase does not create a new database on disk.

Syntax

Dim variableName As New NotesDatabase( server$, dbfile$ )

or

Set notesDatabase = New NotesDatabase( server$, dbfile$ )

Parameters

server$


dbfile$
Return value

notesDatabase

Usage

A database must be open before a script can use the properties and methods in the corresponding NotesDatabase object. In most cases, the class library automatically opens a database for you. But watch out for the following cases:


To test if a database is open, use the IsOpen property. To open a database that's closed, use Open or OpenIfModified.

Access levels

Notes returns an error when a script attempts to perform an operation for which it doesn't have appropriate access. The properties and methods that a script can successfully use on a NotesDatabase object are determined by the following factors:


When a script runs on a server, the script access level to databases and servers corresponds to the access level of the script owner (the person who last saved the script). When a script runs on a workstation, the access level to databases and servers corresponds to the access level of the current user.

Language cross-reference

FileDatabaseInfo @command in formula language

Example
See Also