Table of Contents

Class Database

Namespace
Acuit.Pinpoint.Services.Entities
Assembly
Acuit.Pinpoint.Services.Entities.dll

A database.

[DataContract(IsReference = true)]
[KnownType(typeof(Line))]
public class Database
Inheritance
Database
Inherited Members

Constructors

Database(int, string, string)

Initializes a new instance of the Database class.

public Database(int databaseId, string name, string connectionString)

Parameters

databaseId int

The database identifier.

name string

The database name.

connectionString string

The database connection string.

Exceptions

ArgumentNullException

name is null.

ArgumentNullException

connectionString is null.

Properties

ConnectionString

Gets the database connection string. This will only be set upon a "GetDatabases" Acuit Pinpoint Server API call; otherwise, it will be an empty string.

[DataMember(Order = 2)]
public string ConnectionString { get; }

Property Value

string

DatabaseId

Gets the database identifier.

[DataMember]
public int DatabaseId { get; }

Property Value

int

DatabaseStatus

Gets or sets the database status.

[DataMember]
public DatabaseStatus DatabaseStatus { get; set; }

Property Value

DatabaseStatus

Lines

Gets the list of lines that are stored within this database. This will only be populated for API calls that specifically request database information.

public IList<Line> Lines { get; }

Property Value

IList<Line>

Name

Gets the database name.

[DataMember]
public string Name { get; }

Property Value

string

SchemaVersion

Gets or sets the database schema version, or null if it is not known.

[DataMember(Order = 100)]
public Version? SchemaVersion { get; set; }

Property Value

Version

Unspecified

Gets a singleton instance of the Database class that represents an unspecified database. This is used when an older Acuit Pinpoint API returns a Line object without including its database information in the response.

public static Database Unspecified { get; }

Property Value

Database