dotConnect for BigCommerce Documentation
Retrieving Data

Introduction

This tutorial describes how to use BigcommerceCommand, BigcommerceDataReader, and BigcommerceDataAdapter components.

Requirements

This tutorial supposes that you know how to connect to server.

Note that if you do not use design-time (specifically, if you do not place on a designer BigcommerceConnection component from toolbox), you have to embed license information manually. This is described in the Licensing topic.

General Information

The main function of any database application is establishing a connection to a data source and working with data contained in it. ADO.NET data providers serve as a bridge between an application and a data source, and allow you to execute commands as well as to retrieve data by using a DataReader or a DataAdapter. Updating data involves using the Command and DataAdapter objects.

Retrieving Data using BigcommerceCommand and BigcommerceDataReader

In this sample we will use BigcommerceCommand and BigcommerceDataReader to retrieve data. BigcommerceDataReader allows retrieving data in pages. While you read data from it, it automatically queries next pages from BigCommerce. BigcommerceDataReader offers higher performance than BigcommerceDataAdapter, especially when you query a lot of data. For more information, refer to the description of these classes in our documentation.

using Devart.Data.Bigcommerce;
...
class Program
{
    static void Main(string[] args) {

        const string connectionString = "server=https://my-store.mybigcommerce.com/api/v2/; userid=testuser;Authentication Token=be307be4cb782457be9136608a3b2a459009dc43;";
        const string sql = "SELECT Name, Price FROM Products";

        using (BigcommerceConnection connection = new BigcommerceConnection(connectionString)) {

            connection.Open();
            using (BigcommerceCommand command = connection.CreateCommand()) {

                command.CommandText = sql;
                using (BigcommerceDataReader reader = command.ExecuteReader()) {

                    while (reader.Read()) {

                        Console.WriteLine("{0}\t{1}", reader.GetValue(0), reader.GetValue(1));
                    }
                }
            }
        }
        Console.ReadKey();
    }

}
Imports Devart.Data.Bigcommerce
...
Module Module1

    Sub Main()

        Const connectionString As String = "server=https://my-store.mybigcommerce.com/api/v2/; userid=testuser;Authentication Token=be307be4cb782457be9136608a3b2a459009dc43;"
        Const sql As String = "SELECT Name, Price FROM Products"

        Using connection As New BigcommerceConnection(connectionString)

            connection.Open()
            Using command As BigcommerceCommand = connection.CreateCommand()

                command.CommandText = sql
                Using reader As BigcommerceDataReader = command.ExecuteReader()

                    While reader.Read()

                        Console.WriteLine(reader.GetValue(0) & vbTab & reader.GetValue(1))
                    End While
                End Using
            End Using
        End Using
        Console.ReadKey()
    End Sub

End Module


Retrieving Data using BigcommerceDataAdapter

Applicable only for projects targeting full .NET Framework.

In this sample we will use the BigcommerceDataAdapter component. It retrieves data when you call its Fill method. Note that this method needs to retrieve all the queried data from BigCommerce, and it can take some time.

Here is a small sample that demonstrates usage of BigcommerceDataAdapter to retrieve data.

    static void Main(string[] args) {

        const string connectionString = "server=https://my-store.mybigcommerce.com/api/v2/; userid=testuser;Authentication Token=be307be4cb782457be9136608a3b2a459009dc43;";
        const string sql = "SELECT Name, Price FROM Products";

        using (BigcommerceConnection connection = new BigcommerceConnection(connectionString)) {

            connection.Open();
            DataTable table = new DataTable("Products");

            using (BigcommerceCommand command = connection.CreateCommand()) {

                command.CommandText = sql;
                using (BigcommerceDataAdapter adapter = new BigcommerceDataAdapter(command)) {
                    adapter.Fill(table);
                }
            }

            foreach (DataRow row in table.Rows) {
                Console.WriteLine("{0}\t{1}", row[0], row[1]);
            }
        }
        Console.ReadKey();
    }


    Sub Main()

        Const connectionString As String = "server=https://my-store.mybigcommerce.com/api/v2/; userid=testuser;Authentication Token=be307be4cb782457be9136608a3b2a459009dc43;"
        Const sql As String = "SELECT Name, Price FROM Products"

        Using connection As New BigcommerceConnection(connectionString)

            connection.Open()
            Dim table As New DataTable("Products")

            Using command As BigcommerceCommand = connection.CreateCommand()

                command.CommandText = sql
                Using adapter As New BigcommerceDataAdapter(command)
                    adapter.Fill(table)
                End Using
            End Using

            For Each row As DataRow In table.Rows
                Console.WriteLine(row(0) & vbTab & row(1))
            Next
        End Using
        Console.ReadKey()
    End Sub


Additional Information

This tutorial describes only basic ways of working with data. For example, you can take advantage of using Entity Framework ORM technology which is intended for converting data between incompatible type systems in different data sources and object-oriented programming languages. This technology allow you to decrease the amount of code and maintenance required for data-oriented applications. For more information, please refer to Entity Framework section.

See Also

Entity Framework  | Updating Data