Modifying Data
After Connecting from VBA, you are ready to update Smartsheet from macros. The following sections show how to execute parameterized queries to update data. See Executing Parameterized Queries for a complete macro.
Insert
Call the Insert method to execute SQL INSERT statements.public bool Insert(string queryString, object paramNames, object paramValues)
The Insert method returns a boolean indicating the success or failure of the statement execution and accepts the following parameters:
queryString | The query to execute; for example, INSERT INTO Sheet_Test_Sheet (Name) VALUES ('Basic Agile Project with Gantt Timeline') |
paramNames | An array with the named parameters used in the query. Required if using a parameterized query. |
paramValues | An array with the values that correspond to the parameter names. Required if using a parameterized query. |
The following example inserts the values specified in the parameter arrays and displays a message box indicating the success or failure of the INSERT.
Dim nameArray
nameArray = Array("Name", "Favorite")
Dim valueArray
valueArray = Array("Basic Project with Resource Management", "True")
Dim module As New ExcelComModule
module.SetProviderName ("Smartsheet")
module.SetConnectionString ("OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;")
Query = "INSERT INTO Sheet_Test_Sheet (Name, Favorite) VALUES (@Name, @Favorite)"
If module.Insert(Query, nameArray, valueArray) Then
MsgBox "The insertion was successful."
'lastInsertedRowIdentity = GetLastInsertedRowIdentity(module)
'MsgBox lastInsertedRowIdentity
Else
MsgBox "The insertion failed."
End If
module.Close
For a successful insertion, and if SCOPE_IDENTITY() is supported by the Smartsheet provider, then the following VBA function example can be called to retrieve the last inserted row identity.
Function GetLastInsertedRowIdentity(module) As String
Dim lastInsertedRowIdentity As String
lastInsertedRowIdentity = ""
If module.Select("SELECT SCOPE_IDENTITY()", prmNames, prmValues) Then
lastInsertedRowIdentity = module.GetColumnValue(0)
End If
GetLastInsertedRowIdentity = lastInsertedRowIdentity
End Function
Update
Call the Update method to execute SQL UPDATE statements.
public bool Update(string queryString, object paramNames, object paramValues)
The Update method returns a boolean indicating the success or failure of the statement execution and accepts the following parameters:
queryString | The statement to execute. |
paramNames | An array with the named parameters used in the query. Required if using a parameterized query. |
paramValues | An array with the corresponding parameter values. Required if using a parameterized query. |
The following example updates the values specified in the parameter arrays and displays a message box indicating the success or failure of the update.
Dim nameArray
nameArray = Array("Name", "Favorite","Id")
Dim valueArray
valueArray = Array("Basic Project with Resource Management", "True","123456")
Dim module As New ExcelComModule
module.SetProviderName ("Smartsheet")
module.SetConnectionString ("OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;")
Query = "UPDATE Sheet_Test_Sheet SET Name=@Name, Favorite=@Favorite WHERE Id=@Id
If module.Update(Query, nameArray, valueArray) Then
MsgBox "The update was successful."
Else
MsgBox "The update failed."
End If
module.Close
Delete
Call the Delete method to execute SQL DELETE statements.public bool Delete(string queryString, object paramNames, object paramValues)
The Delete method returns a boolean indicating the query's success or failure and accepts the following parameters:
queryString | The query to execute; for example, SELECT Id, Name FROM Sheet_Test_Sheet WHERE Favorite = 'True' |
paramNames | An array with the named parameters used in the query. Required if using a parameterized query. |
paramValues | An array with the values that correspond to the parameter names. Required if using a parameterized query. |
The following example deletes a record, specified by its key, and displays a message box indicating the success or failure of the delete.
Dim module As New ExcelComModule
module.SetProviderName ("Smartsheet")
module.SetConnectionString("OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;")
Dim nameArray
nameArray = Array("Id")
Dim valueArray
valueArray = Array("123456")
Query = "DELETE FROM Sheet_Test_Sheet WHERE Id='123456'"
If module.Delete(Query,nameArray,valueArray) Then
MsgBox "The delete was successful."
Else
MsgBox "The delete failed."
End If
module.Close