Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFDatabases Class

  • Last UpdatedNov 18, 2025
  • 7 minute read
AFDatabases Class
The collection of AFDatabase objects maintained by the SDK for elements on the PISystem.

Inheritance Hierarchy

SystemObject
  OSIsoft.AFAFCollection
    OSIsoft.AFAFCollectionAFDatabase
      OSIsoft.AFAFNamedCollectionAFDatabase
        OSIsoft.AFAFDatabases

Namespace:  OSIsoft.AF
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public sealed class AFDatabases : AFNamedCollection<AFDatabase>
Public NotInheritable Class AFDatabases
	Inherits AFNamedCollection(Of AFDatabase)

Dim instance As AFDatabases
public ref class AFDatabases sealed : public AFNamedCollection<AFDatabase^>
[<SealedAttribute>]
type AFDatabases =  
    class
        inherit AFNamedCollection<AFDatabase>
    end

The AFDatabases type exposes the following members.

Properties

  NameDescription
Public property
ConfigurationDatabase
This read-only property returns an AFDatabase object that represents the configuration database used to store application configuration information.
Public property
Count
Gets the number of items actually contained in the collection.
(Inherited from AFCollectionT.)
Public property
DefaultDatabase
This property returns an AFDatabase object that represents the default database configured in the SDK.
Public property
Identity
This read-only property contains identity of the object.
(Inherited from AFCollection.)
Public property
IsDeleted
This read-only property indicates whether the owner of the collection has been deleted.
(Inherited from AFCollection.)
Public property
ItemGuid
Returns the item in the collection associated with the passed in ID.
(Inherited from AFCollectionT.)
Public property
ItemInt32
Returns the item located at the passed in index.
(Inherited from AFCollectionT.)
Public property
ItemString
Returns the specified object from the collection by name.
(Inherited from AFNamedCollectionT.)
Public property
ItemIdentity
This read-only property specifies the identity of the objects within the collection.
(Inherited from AFCollection.)
Public property
PISystem
This read-only property allows access to the PISystem associated with this collection.
(Inherited from AFCollection.)

Methods

  NameDescription
Public method
Add(T)
Adds an object to the end of the collection.
(Inherited from AFCollectionT.)
Public method
Add(String)
Adds a new database to the list of known databases on the local machine.
Public method
Clear
Removes all items from the collection.
(Inherited from AFCollectionT.)
Public method
Contains(Guid)
This method determines whether the collection contains a specific item referenced by id.
(Inherited from AFCollectionT.)
Public method
Contains(T)
This method determines whether the collection contains a specific item.
(Inherited from AFCollectionT.)
Public method
Contains(String)
This method determines whether the collection contains a specific item referenced by name.
(Inherited from AFNamedCollectionT.)
Public method
CopyTo
Copies the entire collection to a compatible one-dimensional Array, starting at the specified index of the target array.
(Inherited from AFCollectionT.)
Public method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public method
GetEnumerator
Returns an enumerator that iterates through the collection.
(Inherited from AFCollectionT.)
Public method
GetHashCode
Gets the hash code for this instance of the object which is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from AFCollection.)
Public method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public method
IndexOf
Searches for the specified object and returns the zero-based index of the first occurrence within the entire collection.
(Inherited from AFCollectionT.)
Public method
Refresh
Refresh the collection to make sure it's list of items is up-to-date.
Public method
Remove(Guid)
Removes the item with the specified id from the collection.
(Inherited from AFCollectionT.)
Public method
Remove(T)
Removes the first occurrence of a specific object from the collection.
(Inherited from AFCollectionT.)
Public method
Remove(String)
The Remove method removes the item from the collection by name.
(Inherited from AFNamedCollectionT.)
Public method
RemoveAt
Removes the item at the specified index of the collection.
(Inherited from AFCollectionT.)
Public method
Sort
Sorts the items in the entire collection using the default comparer.
(Inherited from AFCollectionT.)
Public method
Sort(IComparerT)
Sorts the items in the entire collection using the specified comparer.
(Inherited from AFCollectionT.)
Public method
Sort(Int32, Int32, IComparerT)
Sorts the items in a range of items in the collection using the specified comparer.
(Inherited from AFCollectionT.)
Public method
ToString
Returns a String that represents the current object.
(Inherited from AFCollection.)

Remarks

The AFDatabases collection, maintained by the SDK for elements, represents all the defined AFDatabase objects on an PISystem. This list of databases can be manipulated with the methods of this object. For example, the Add(String) method is used to add a database to the PISystem.

Examples

// This example demonstrates how to use several properties of the AFDatabase object.

// Get the Database
PISystems myPISystems = new PISystems();
PISystem myPISystem = myPISystems.DefaultPISystem;
AFDatabase myDB = myPISystem.Databases.DefaultDatabase;

// Display information about the Default DB
Console.WriteLine("Name of Default DB = {0}", myDB.Name);
Console.WriteLine("Description of Default DB = {0}", myDB.Description);
Console.WriteLine("UniqueID of DefaultDB = {0}", myDB.UniqueID);

// Set the DB to the First DB
myDB = myPISystem.Databases[0];

// Display the Name, Description, and UniqueID of the first db
Console.WriteLine("Name of First DB = {0}", myDB.Name);
Console.WriteLine("Description of First DB = {0}", myDB.Description);
Console.WriteLine("UniqueID of First DB = {0}", myDB.UniqueID);

// Add a new Database
AFDatabase newDB = myPISystem.Databases.Add("NewDatabase");
newDB.Description = "This is a new Database";

// Display the Database Count
Console.WriteLine("Database Count = {0}", myPISystem.Databases.Count);
' This example demonstrates how to use several properties of the DB object.

' Get the Database
Dim myPISystems As New PISystems
Dim myPISystem As PISystem = myPISystems.DefaultPISystem
Dim myDB As AFDatabase = myPISystem.Databases.DefaultDatabase

' Display information about the Default DB
Console.WriteLine("Name of Default DB = {0}", myDB.Name)
Console.WriteLine("Description of Default DB = {0}", myDB.Description)
Console.WriteLine("UniqueID of Default DB = {0}", myDB.UniqueID)

' Set the DB to the First DB
myDB = myPISystem.Databases(0)

' Display the name, description, and PIServerName of the first db
Console.WriteLine("Name of First DB = {0}", myDB.Name)
Console.WriteLine("Description of First DB = {0}", myDB.Description)
Console.WriteLine("UniqueID of First DB = {0}", myDB.UniqueID)

' Add a new Database
Dim newDB As AFDatabase = myPISystem.Databases.Add("NewDatabase")
newDB.Description = "This is a new Database"

' Display the Database Count
Console.WriteLine("Database Count = {0}", myPISystem.Databases.Count)

No code example is currently available or this language may not be supported.

No code example is currently available or this language may not be supported.

Version Information

AFSDK


See Also

TitleResults for “How to create a CRG?”Also Available in