dotConnect for BigCommerce Documentation
In This Topic
    Using Parameters
    In This Topic

    dotConnect for BigCommerce enhances SQL handling capabilities with usage of parameters in SQL queries. You can make execution of a query or stored procedure very flexible using several simple techniques. This article describes some basics you must be acquainted with when working with parameters in dotConnect for BigCommerce, as well as parameters synchronization and some nuances related to usage of stored procedures.

    The article consists of following sections:

    Parameters Basics

    In general, parameter is a placeholder for a variable that contains some value of some type when executing a general-purpose query, or arguments and return values when a function is executed. Parameter is represented by the BigcommerceParameter class. All parameters that take part in query execution constitute a collection that can be accessed through BigcommerceCommand.Parameters property.

    Parameters must correspond to the names of the BigcommerceParameter instances in the collection. Named parameters are declared using ':' or '@' prefix followed by name of the parameter. The name of the BigcommerceParameter object in the command's collection should be used without any prefix. You can use these prefixes at any combinations to specify parameters. There are two main advantages of named parameters. First, you do not have to care about the order in which parameters are created. Second, named parameter can appear more than once in query text, but you have to create only one instance of it in Parameters collection.

    For example, a simple Update statement that requires named parameters might look like the following:

    UPDATE Products SET Price = :price WHERE Name = :name

    To set parameters for this query you can use the next code:

    
        using (var connection = new BigcommerceConnection("server=https://my-store.mybigcommerce.com/api/v2/; userid=testuser;Authentication Token=be307be4cb782457be9136608a3b2a459009dc43;")) {
            connection.Open();
    
            BigcommerceCommand cmd = connection.CreateCommand();
            cmd.CommandText = "UPDATE Products SET Price = :price WHERE Name = :name";
            cmd.Parameters.Add("price", DbType.Decimal).Value = 100.0m;
            cmd.Parameters.Add("name", DbType.String).Value = "sample name 1";
    
            cmd.ExecuteNonQuery();
        }
    
    
    
    
        Using connection As New BigcommerceConnection("server=https://my-store.mybigcommerce.com/api/v2/; userid=testuser;Authentication Token=be307be4cb782457be9136608a3b2a459009dc43;")
            connection.Open()
    
            Dim cmd As BigcommerceCommand = connection.CreateCommand()
            cmd.CommandText = "UPDATE Products SET Price = :price WHERE Name = :name"
            cmd.Parameters.Add("price", DbType.Decimal).Value = 100.0D
            cmd.Parameters.Add("name", DbType.String).Value = "sample name 1"
    
            cmd.ExecuteNonQuery()
        End Using
    
    
    
    
    

    Using Automatic Parameters Synchronization

    The behavior described above assumes that BigcommerceCommand.ParameterCheck is false (by default). By turning it on you enable automatic synchronization of query text and BigcommerceCommand.Parameters collection. In this mode all input parameters are checked for validity, new ones are added if necessary, and redundant parameters are deleted. Thus you do not have to take care about quantity of items in BigcommerceCommand.Parameters collection, you can specify only the ones you really need. The synchronization is done as follows:

    The synchronization takes place when:

    When BigcommerceCommand.ParameterCheck is true, every change of BigcommerceCommand.CommandText or BigcommerceCommand.CommandType leads to deletion of all ReturnValue parameters. You have to add them manually each time you change one of these properties.