NotesDatabase
Properties
| Name | Description |
|---|---|
| ACL | Read-only. The access control list for a database. |
| ACLActivityLog | Read-only. The log from the access control list for a database. |
| Agents | Read-only. All of the agents in a database. |
| AllDocuments | Read-only. All the documents in a database. |
| Categories | Read-write. The categories under which a database appears in a database catalog. |
| Created (NotesDatabase) | Read-only. The date/time that a database was created. |
| CurrentAccessLevel | Read-only. The current user's access level to a database. |
| DelayUpdates | Read-write. Indicates whether updates to a server are delayed (batched) for better performance. |
| DesignTemplateName | Read-only. The name of the design template from which a database inherits its design. If the database does not inherit its design from a design template,… |
| EncryptionStrength | The encryption strength of a database. |
| FileFormat | Read-only. The ODS (on-disk structure) version of a database. |
| FileName | Read-only. The full file name of a database, including the extension but excluding the path. |
| FilePath | Read-only. The path and file name of a database. The file name includes the NSF extension. |
| FolderReferencesEnabled | Read-write. Indicates whether this database maintains folder references for documents. |
| Forms | Read-only. All the forms in a database. |
| FTIndexFrequency | Read-write. Update frequency of a database's full-text index. |
| HttpURL (NotesDatabase) | Read-only. The Domino® URL of a database when HTTP protocols are in effect. |
| IsClusterReplication | Read-write. Indicates whether cluster replication is in effect for a database on a server in a cluster. |
| IsConfigurationDirectory | Read-only. Indicates whether a database is a Configuration Directory database. |
| IsCurrentAccessPublicReader | Read-only. Indicates whether the current user has public reader access in a database. |
| IsCurrentAccessPublicWriter | Read-only. Indicates whether the current user has public writer access in a database. |
| IsDesignLockingEnabled | Read-write. Indicates whether design locking is enabled for a database. |
| IsDocumentLockingEnabled | Read-write. Indicates whether document locking is enabled for a database. |
| IsFTIndexed | Read-only. Indicates whether or not a database has a full-text index. |
| IsInMultiDbIndexing | Read-write. Indicates whether a database can be included in multi-database indexing. |
| IsInService | Read-write. Indicates whether a database on a server in a cluster is accessible. |
| IsLink | Read-only. Indicates whether a database is the target of a link. |
| IsLocallyEncrypted | Indicates whether a database is locally encrypted. Read-only. |
| IsMultiDbSearch | Read-only. Indicates whether a database is of type "Multi DB Search." |
| IsOpen | Read-only. Indicates whether a database is open. |
| IsPendingDelete | Read-only. Indicates whether a database on a server in a cluster is marked for deletion. |
| IsPrivateAddressBook | Read-only. Indicates whether a database is a Personal Address Book. |
| IsPublicAddressBook | Read-only. Indicates whether a database is a Domino® Directory. |
| LastFixup | Read-only. The date that a database was last checked by the Fixup task. |
| LastFTIndexed | Read-only. The date that a database full-text index was last updated. |
| LastModified (NotesDatabase) | Read-only. The date/time that a database was last modified. |
| LimitRevisions | Read-write. The maximum number of entries allowed in the $Revisions field. |
| LimitUpdatedBy | Read-write. The maximum number of entries allowed in the $UpdatedBy field. |
| ListInDbCatalog | Read-write. Indicates whether a database appears in database catalogs. |
| Managers | Read-only. People, servers, and groups that have Manager access to a database. |
| MaxSize | Read-only. Shows the maximum size assigned to the database when the database was created. |
| NotesURL (NotesDatabase) | Read-only. The Domino® URL of a database when Notes® protocols are in effect. |
| Parent (NotesDatabase) | Read-only. The Notes® session that contains a database. |
| PercentUsed | Read-only. The percent of the total size of a database that is occupied by real data (and not empty space). |
| ReplicaID | Read-only. A 16-character combination of letters and numbers that represents the replica ID of a Notes® database. Any databases with the same replica ID… |
| ReplicationInfo | Read-only. Provides access to a NotesReplication object. Each NotesDatabase instance contains one NotesReplication object. |
| Server (NotesDatabase) | Read-only. The name of the server where a database resides. |
| Size (NotesDatabase) | Read-only. The size of a database, in bytes. |
| SizeQuota | Read-write. The size quota of a database, in kilobytes. |
| SizeWarning | Read-write. The size warning threshold of a database, in kilobytes. |
| TemplateName | Read-only. The template name of a database, if the database is a template. If the database is not a template, returns an empty string (""). |
| Title (NotesDatabase) | Read-write. The title of a database. |
| Type (NotesDatabase) | Read-only. Database type. |
| UndeleteExpireTime | Read-write. The number of hours before soft deletions become hard deletions. |
| UnprocessedDocuments | Read-only. The documents in a database that the current agent or view action considers to be "unprocessed." The type of agent determines which documents… |
| Views (NotesDatabase) | Read-only. The views and folders in a database. |
Methods
| Name | Description |
|---|---|
| Compact (NotesDatabase) | Compacts a local database. |
| CompactWithOptions | Compacts a local database allowing the submission of options. |
| Create | Creates a new database on disk, using the server and file name that you specify. |
| CreateCopy | Creates an empty copy of the current database. |
| CreateDocument | Creates a document in a database and returns a NotesDocument object that represents the new document. You must call Save if you want the new document to… |
| CreateDocumentCollection | Returns an empty document collection. |
| CreateDominoQuery | Gets an instance of the NotesDominoQuery class for use in running DQL queries. |
| CreateFromTemplate | Creates a new database from an existing database. |
| CreateFTIndex (NotesDatabase) | Creates a full-text index for a database. |
| CreateNoteCollection | Creates a note collection based on the current database and returns a NotesNoteCollection object that represents the note collection. |
| CreateOutline | Creates a new outline within the current database and returns a NotesOutline object that represents the new outline. This method allows you to create a… |
| CreateQueryResultsProcessor | Gets an instance of the NotesQueryResultsProcessor class for use processing the document collections and output of DQL queries. |
| CreateReplica (NotesDatabase) | Creates a replica of the current database at a new location. |
| CreateView | Creates a view. |
| Decrypt | Decrypts a database |
| EnableFolder | Given a folder name, enables the folder. |
| Encrypt (NotesDatabase) | Encrypts a database. |
| Fixup | Runs the Fixup task on a database. |
| FTDomainSearch | Conducts a Domain Search, that is, a full-text search of all databases configured in the Domain Catalog database and marked as included for… |
| FTSearch (NotesDatabase) | Conducts a full-text search of all the documents in a database. |
| FTSearchRange | Conducts a full-text search of all the documents in a database. |
| GetAgent | Finds an agent in a database, given the agent name. |
| GetDocumentByID | Finds a document in a database, given the document's note ID. |
| GetDocumentByUNID | Finds a document in a database, given the document universal ID (UNID). |
| GetDocumentByURL | Instantiates a document in the database on which it is called and returns a NotesDocument object for it. This method is typically used for either the… |
| GetForm | Finds a form in a database, given the form name. |
| GetModifiedDocuments | Gets the documents in a database that are modified since a specified time. |
| GetModifiedDocumentsWithOptions | Lets you retrieve all modified documents meeting matches for specified options. |
| GetNamedDocCollection | Returns a collection of named documents. |
| GetNamedDocument | Returns a named document. |
| GetOption | Gets the value of a database option. |
| GetOutline | Retrieves an existing outline within the current database and returns a NotesOutline object that represents the outline. |
| GetProfileDocCollection | Given a profile name, returns a collection of Profile documents that match the name, or if no name is given, a collection of all Profile documents. |
| GetProfileDocument | Retrieves or creates a Profile document. |
| GetURLHeaderInfo | Gets the specific Hypertext Transfer Protocol (HTTP) header information from the Uniform Resource Locator (URL). A URL is a text string used for… |
| GetView | Finds a view or folder in a database, given the name or alias of the view or folder. |
| GrantAccess | Modifies a database access control list to provide the specified level of access to a person, group, or server. |
| MarkForDelete | Marks a database for deletion from a server in a cluster. |
| Open (NotesDatabase) | Opens a database. A database must be open in order to access all its properties and methods. For details on accessing the properties and methods of a… |
| OpenByReplicaID | Given a server name and a replica ID, opens the specified database, if it exists. |
| OpenIfModified | Given a date, opens the specified database if it has been modified since that date. |
| OpenMail | Assigns a database to the current user's mail database and opens that database. |
| OpenURLDb | Finds and opens the default Web Navigator database. |
| OpenWithFailover | Opens a database on a server. |
| QueryAccess | Returns the current access level of a person, group, or server to a database. |
| QueryAccessPrivileges | Returns the privileges of a person, group, or server in a database. |
| QueryAccessRoles | Returns the roles of a person, group, or server in a database. |
| Remove (NotesDatabase) | Permanently deletes a database from disk. |
| RemoveFTIndex | Removes a full-text index from a database. |
| Replicate | Replicates a database with its replica(s) on a given server. |
| RevokeAccess | Removes a person, group, or server from a database access control list. This resets the access level for that person, group, or server to the Default… |
| Search | Given selection criteria for a document, returns all documents in a database that meet the criteria. |
| SetOption | Sets the value of a database option. |
| Sign (NotesDatabase) | Signs elements in a database with the signature of the current user. This method programmatically mimics the use of the Sign Database dialog in the… |
| TransactionBegin | Begins recording changes to a database on a Domino server. |
| TransactionRollback | Discards database changes recorded by TransactionBegin. |
| UnprocessedFTSearch | Conducts a full-text search of the documents in a database that the current agent considers to be unprocessed. |
| UnprocessedFTSearchRange | Conducts a full-text search of the documents in a database that the current agent considers to be unprocessed. |
| UnprocessedSearch | Given selection criteria for a document, returns documents in a database that: |
| UpdateFTIndex | Updates the database full-text index. |
Examples
| Name | Description |
|---|---|
| Examples: AllDocuments property | 1. This script gets a collection of every document in the current database. For example, if there are 56 documents in the database, AllDocuments returns… |
| Examples: Compact method (NotesDatabase) | 1. This script compacts WHITESPC.NSF if less than 85% of its disk space is occupied by real data. |
| Examples: Created property (NotesDatabase) | 1. This script gets the date/time that the current database was created. For example, the Created property might return 10/15/95 4:43:51 PM. |
| Examples: CreateReplica method (NotesDatabase) | This script creates a replica of the current database on the server Jakarta. |
| Examples: DesignTemplateName property | 1. This script gets the design template name of the database CBANNER.NSF. Since CBANNER.NSF is a mail file, the method returns "STDR4MAIL." |
| Examples: FileFormat property | This agent gets the ODS version of the databases in the local directory. |
| Examples: FileName property | This script gets the file name and title of the current database. |
| Examples: FilePath property | This button displays the title and path of the current database. |
| Examples: Forms property | This example displays the names of all the forms in the current database. |
| Examples: FTSearch method (NotesDatabase) | 1. This agent returns all the documents in the current database that contain a user-specified string. |
| Examples: FTSearchRange method | This agent returns all the documents in the current database that contain a user-specified string, in groups of eight. |
| Examples: IsClusterReplication property | This agent toggles cluster replication for a database. |
| Examples: IsConfigurationDirectory property | This agent displays the Configuration Directory databases known to the current session. |
| Examples: IsCurrentAccessPublicReader property | This agent opens a database in the workspace if the user has public reader access to it. |
| Examples: IsCurrentAccessPublicWriter property | This agent opens a database in the workspace if the user has public writer access to it. |
| Examples: IsDesignLockingEnabled property | 1. This agent displays whether design locking is enabled for the current database. |
| Examples: IsDirectoryCatalog property | The following agent determines if databases are Directory Catalogs. |
| Examples: IsDocumentLockingEnabled property | 1. This agent displays whether document locking is enabled for the current database. |
| Examples: IsFTIndexed property | 1. This script checks if the current database has a full-text index before calling the FTSearch method. |
| Examples: IsInMultiDbIndexing property | This agent toggles the setting for including the current database in multi-database indexing. |
| Examples: IsInService property | This agent toggles whether a database is in service. |
| Examples: IsLink property | This agent gets the path names of all linked databases in the local directory. |
| Examples: IsMultiDbSearch property | This example displays the status of IsMultiDbSearch. |
| Examples: IsOpen property | This script attempts to open TODO.NSF on the server Bombay. If the database is found, it is opened, and IsOpen returns True. If the database is not found… |
| Examples: IsPendingDelete property | This agent exits the Sub if a database is pending deletion. |
| Examples: IsPrivateAddressBook property | This agent displays the Personal Address Book databases known to the current session. |
| Examples: IsPublicAddressBook property | This agent displays the Domino® Directory databases known to the current session. |
| Examples: LastFixup property | This agent displays the last fixup date for the local databases. |
| Examples: LastFTIndexed property | 1. This script gets the date that the current database was last full-text indexed. For example, the LastFTIndexed property might return 10/30/95 6:36:18… |
| Examples: LastModified property (NotesDatabase) | 1. This script gets the date that the current database was last modified. For example, the LastModified property might return 10/30/95 1:35:44 PM. |
| Examples: LimitRevisions property | This agent cycles the revision limit from 0 to 1000 in increments of 100. |
| Examples: LimitUpdatedBy property | This agent cycles the updated-by limit from 0 to 1000 in increments of 100. |
| Examples: ListInDbCatalog property | This agent toggles whether the current database is listed in a database catalog. |
| Examples: Managers property | 1. This script displays the name of every manager in the current database. For example, it might display "Helen Anda," "LocalDomainServers," and "Sales." |
| Examples: Parent property (NotesDatabase) | This script gets the current Notes® session. It then displays the name of the platform on which the current session is running; for example, if the… |
| Examples: Remove method (NotesDatabase) | This script deletes BYEBYE.NSF if it has not been modified in the last 100 days. |
| Examples: Sign method (NotesDatabase) | This agent signs the forms in the current database. |
| Examples: Title property (NotesDatabase) | 1. This script displays the title of the current database. |
Reference
| Name | Description |
|---|---|
| GetAllReadDocuments | Creates a note collection of all read documents in the database. |
| GetAllUnreadDocuments | Creates a note collection of all unread documents in the database. |
| IsDirectoryCatalog | Read-only. Indicates whether a database is a Directory Catalog database, also known as the Light Weight NAB, or the Enterprise Address Book. |
| SetUserIDForDecrypt | After calling this method on a database, any document that is opened within the database is decrypted using the encryption keys within the userID object,… |