Go Snowflake Driver

This topic provides instructions for installing, running, and modifying the Go Snowflake Driver. The driver supports Go's database/sql package.

Prerequisites

The following software packages are required to use the Go Snowflake Driver.

Go

The latest driver requires the Go language 1.17 or higher. The supported operating systems are Linux, Mac OS, and Windows, but you may run the driver on other platforms if the Go language works correctly on those platforms.

Installation

Get Gosnowflake source code, if not installed.

go get -u github.com/snowflakedb/gosnowflake

Docs

For detailed documentation and basic usage examples, please see the documentation at godoc.org.

Sample Programs

Snowflake provides a set of sample programs to test with. Set the environment variable $GOPATH to the top directory of your workspace, e.g., ~/go and make certain to include $GOPATH/bin in the environment variable $PATH. Run the make command to build all sample programs.

make install

In the following example, the program select1.go is built and installed in $GOPATH/bin and can be run from the command line:

SNOWFLAKE_TEST_ACCOUNT=<your_account> \
SNOWFLAKE_TEST_USER=<your_user> \
SNOWFLAKE_TEST_PASSWORD=<your_password> \
select1
Congrats! You have successfully run SELECT 1 with Snowflake DB!

Development

The developer notes are hosted with the source code on GitHub.

Testing Code

Set the Snowflake connection info in parameters.json:

{
    "testconnection": {
        "SNOWFLAKE_TEST_USER":      "<your_user>",
        "SNOWFLAKE_TEST_PASSWORD":  "<your_password>",
        "SNOWFLAKE_TEST_ACCOUNT":   "<your_account>",
        "SNOWFLAKE_TEST_WAREHOUSE": "<your_warehouse>",
        "SNOWFLAKE_TEST_DATABASE":  "<your_database>",
        "SNOWFLAKE_TEST_SCHEMA":    "<your_schema>",
        "SNOWFLAKE_TEST_ROLE":      "<your_role>"
    }
}

Install jq so that the parameters can get parsed correctly, and run make test in your Go development environment:

make test

Submitting Pull Requests

You may use your preferred editor to edit the driver code. Make certain to run make fmt lint before submitting any pull request to Snowflake. This command formats your source code according to the standard Go style and detects any coding style issues.

Support

For official support, contact Snowflake support at: https://support.snowflake.net/.

Name		Name	Last commit message	Last commit date
Latest commit History 763 Commits
.github		.github
benchmark		benchmark
ci		ci
cmd		cmd
test_data		test_data
vendor		vendor
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
.semgrep.yml		.semgrep.yml
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
arrow_chunk.go		arrow_chunk.go
arrow_test.go		arrow_test.go
async.go		async.go
async_test.go		async_test.go
auth.go		auth.go
auth_test.go		auth_test.go
authexternalbrowser.go		authexternalbrowser.go
authexternalbrowser_test.go		authexternalbrowser_test.go
authokta.go		authokta.go
authokta_test.go		authokta_test.go
azure_storage_client.go		azure_storage_client.go
bind_uploader.go		bind_uploader.go
bindings_test.go		bindings_test.go
cacert.go		cacert.go
chunk.go		chunk.go
chunk_downloader.go		chunk_downloader.go
chunk_test.go		chunk_test.go
client.go		client.go
client_test.go		client_test.go
connection.go		connection.go
connection_test.go		connection_test.go
connection_util.go		connection_util.go
connector.go		connector.go
connector_test.go		connector_test.go
converter.go		converter.go
converter_test.go		converter_test.go
ctx_test.go		ctx_test.go
datatype.go		datatype.go
datatype_test.go		datatype_test.go
debug.go		debug.go
doc.go		doc.go
driver.go		driver.go
driver_ocsp_test.go		driver_ocsp_test.go
driver_test.go		driver_test.go
dsn.go		dsn.go
dsn_test.go		dsn_test.go
encrypt_util.go		encrypt_util.go
encrypt_util_test.go		encrypt_util_test.go
errors.go		errors.go
errors_test.go		errors_test.go
file_compression_type.go		file_compression_type.go
file_transfer_agent.go		file_transfer_agent.go
file_util.go		file_util.go
gcs_storage_client.go		gcs_storage_client.go
go.mod		go.mod
go.sum		go.sum
gosnowflake.mak		gosnowflake.mak
heartbeat.go		heartbeat.go
local_storage_client.go		local_storage_client.go
location.go		location.go
location_test.go		location_test.go
log.go		log.go
monitoring.go		monitoring.go
multistatement.go		multistatement.go
multistatement_test.go		multistatement_test.go
ocsp.go		ocsp.go
ocsp_test.go		ocsp_test.go
old_driver_test.go		old_driver_test.go
parameters.json.tmpl		parameters.json.tmpl
prepared_statement_test.go		prepared_statement_test.go
priv_key_test.go		priv_key_test.go
priv_key_test_coding_helper.go		priv_key_test_coding_helper.go
put_get_test.go		put_get_test.go
put_get_user_stage_test.go		put_get_user_stage_test.go
put_get_with_aws_test.go		put_get_with_aws_test.go
query.go		query.go
release.go		release.go
restful.go		restful.go
restful_test.go		restful_test.go
result.go		result.go
retry.go		retry.go
retry_test.go		retry_test.go
rows.go		rows.go
rows_test.go		rows_test.go
s3_storage_client.go		s3_storage_client.go
s3_storage_client_test.go		s3_storage_client_test.go
secret_detector.go		secret_detector.go
secret_detector_test.go		secret_detector_test.go
sqlstate.go		sqlstate.go
statement.go		statement.go
statement_test.go		statement_test.go
storage_client.go		storage_client.go
telemetry.go		telemetry.go
telemetry_test.go		telemetry_test.go
transaction.go		transaction.go
transaction_test.go		transaction_test.go
util.go		util.go

License

Greyeye/gosnowflake

Folders and files

Latest commit

History