Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(FIR-36644): Clarify named parameters usage #116

Merged
merged 1 commit into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ go get github.com/firebolt-db/firebolt-go-sdk
```

### Example
Here is an example of establishing a connection and executing a simple select query.
Here is an example of establishing a connection and executing a simple select query.
For it to run successfully, you have to specify your credentials, and have a default engine up and running.
```go
package main
Expand All @@ -42,8 +42,20 @@ func main() {
fmt.Println("error during opening a driver: %v", err)
}

// Create table
_, err := db.Query("CREATE TABLE test_table(id INT, value TEXT)")
if err != nil {
fmt.Println("error during select query: %v", err)
}

// Parametrized insert (only ? placeholders are supported)
_, err := db.Query("INSERT INTO test_table VALUES (?, ?)", 1, "my value")
if err != nil {
fmt.Println("error during select query: %v", err)
}

// executing a simple select query
rows, err := db.Query("SELECT 1 UNION SELECT 2")
rows, err := db.Query("SELECT * FROM test_table")
if err != nil {
fmt.Println("error during select query: %v", err)
}
Expand All @@ -62,7 +74,7 @@ func main() {


### DSN (Data source name)
All information for the connection should be specified using the DSN string. The firebolt dsn string has the following format:
All information for the connection should be specified using the DSN string. The firebolt dsn string has the following format:
```
firebolt://[/database]?account_name=account_name&client_id=client_id&client_secret=client_secret[&engine=engine]
```
Expand All @@ -75,4 +87,5 @@ firebolt://[/database]?account_name=account_name&client_id=client_id&client_secr

### Limitations
Although, all interfaces are available, not all of them are implemented or could be implemented:
- `driver.Result` is a dummy implementation and doesn't return the real result values.
- `driver.Result` is a dummy implementation and doesn't return the real result values.
- Named query parameters are not supported
27 changes: 27 additions & 0 deletions driver_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -294,3 +294,30 @@ func TestIncorrectQueryThrowingStructuredError(t *testing.T) {
t.Errorf("Query didn't return an error with correct message, got: %s", err.Error())
}
}

func TestParametrisedQuery(t *testing.T) {
ctx := context.TODO()
db, err := sql.Open("firebolt", dsnSystemEngineMock)
if err != nil {
t.Errorf("failed unexpectedly with %v", err)
}
query := "SELECT engine_name, status from information_schema.engines WHERE engine_name = ? AND status = ?"
stmt, err := db.PrepareContext(ctx, query)
if err != nil {
t.Errorf("The query %s returned an error: %v", query, err)
}
rows, err := stmt.QueryContext(ctx, engineNameMock, "RUNNING")
if err != nil {
t.Errorf("The query %s returned an error: %v", query, err)
}
if !rows.Next() {
t.Errorf("Next returned end of output")
}
var engineName, status string
if err := rows.Scan(&engineName, &status); err != nil {
t.Errorf("Scan returned an error: %v", err)
}
if engineName != engineNameMock || status != "RUNNING" {
t.Errorf("Results not equal: %s %s", engineName, status)
}
}
Loading