ADO.NET Provider for FreshBooks

Build 20.0.7587

Indexes

You can retrieve information on indexes, such as the primary keys, by querying the Indexes collection.

Retrieving Primary Key Information

To retrieve this schema collection, call the GetSchema method of the FreshBooksConnection class. You can restrict the results by table name. The following example retrieves the primary key of the FreshBooks table Clients.

C#

String connectionString = "InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost:33333";

using (FreshBooksConnection conn = new FreshBooksConnection(connectionString)) {
  conn.Open();
  DataTable databaseSchema = conn.GetSchema("Indexes", new string[] {"Clients"});
  foreach (DataRow row in databaseSchema.Rows) {
    Console.WriteLine(row["INDEX_NAME"]);
    Console.WriteLine(row["PRIMARY"]);
  }
}

VB.NET

Dim connectionString As String = "InitiateOAuth=GETANDREFRESH;OAuthClientId=MyClientId;OAuthClientSecret=MyClientSecret;CallbackURL=http://localhost:33333"

Using conn As New FreshBooksConnection(connectionString)
  conn.Open()
  Dim databaseSchema As DataTable = conn.GetSchema("Indexes",  New String() {"Clients"})
  For Each row As DataRow In databaseSchema.Rows
    Console.WriteLine(row("INDEX_NAME"))
    Console.WriteLine(row("PRIMARY"))
  Next
End Using

Columns Returned

The Indexes schema collection contains the following columns:

Column NameData TypeDescription
INDEX_CATALOGSystem.StringThe name of the database containing the index.
INDEX_SCHEMASystem.StringThe name of the schema containing the index.
TABLE_NAMESystem.StringThe name of the table containing the index.
INDEX_NAMESystem.StringThe name of the index.
UNIQUESystem.BooleanWhether the index is unique.
PRIMARYSystem.BooleanWhether the index is a primary key.
TYPESystem.Int32An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
COMMENTSystem.StringA description of the index.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587