SugarLoader component is used for bulk uploading a large number of records to SugarCRM.

To start uploading data, create a SugarLoader component. Then you may tweak its BatchSize property. BatchSize property determines a maximal number of records in a batch. After this you need to specify columns to load data. You may do it either manually, using the Columns property, or you may use the CreateColumns method to retrieve table columns information from the table specified in the TableName property. Then call the Open method and use the SetValue method to set values for the row fields. To switch to the next row, call the NextRow method.

After you have finished loading data, call the Close method. This mthod sends the last batch to the server.

The following example demonstrates using the SugarLoader class.

using (var connection = new SugarConnection("server=https://your_company.sugaropencloud.eu;user id=admin;password=AmFFA4ZryM;")) {
    connection.Open();

    SugarLoader loader = new SugarLoader("Campaigns", connection);
    loader.Columns.Add("name", DbType.String, 0, 0, 0);
    loader.Columns.Add("end_date", DbType.Date, 0, 0, 0);
    loader.Columns.Add("status", DbType.String, 0, 0, 0);
    loader.Columns.Add("campaign_type", DbType.String, 0, 0, 0);

    try {
        loader.Open();
        for (int i = 1; i <= 100; i++) {
            loader.SetValue("name", "Test " + i);
            loader.SetValue("end_date", DateTime.Now);
            loader.SetValue("status", "active");
            loader.SetValue("campaign_type", "email");
            loader.NextRow();
        }
        loader.Close();
    }
    catch (SugarException ex) {
                    
        // process exception
    }
}

Using connection As New SugarConnection("server=https://your_company.sugaropencloud.eu;user id=admin;password=AmFFA4ZryM;")
    connection.Open()

    Dim loader As New SugarLoader("Campaigns", connection)
    loader.Columns.Add("name", DbType.String, 0, 0, 0)
    loader.Columns.Add("end_date", DbType.Date, 0, 0, 0)
    loader.Columns.Add("status", DbType.String, 0, 0, 0)
    loader.Columns.Add("campaign_type", DbType.String, 0, 0, 0)

    Try
        loader.Open()
        For i As Integer = 1 To 100
            loader.SetValue("name", "Test " & i)
            loader.SetValue("end_date", DateTime.Now)
            loader.SetValue("status", "active")
            loader.SetValue("campaign_type", "email")
            loader.NextRow()
        Next
        loader.Close()

    Catch ex As SugarException
        'process exception

    End Try
End Using

After calling the Close method you can retrieve the results of data loading operation as an array of structs with the GetResults method.