vst

Overview ¶

Package vst implements driver.Connection using a VelocyStream connection.

This connection uses VelocyStream (with optional TLS) to connect to the ArangoDB database. It encodes its contents as Velocypack.

Creating an Insecure Connection ¶

To create a VST connection, use code like this.

// Create a VST connection to the database
conn, err := vst.NewConnection(vst.ConnectionConfig{
	Endpoints: []string{"http://localhost:8529"},
})
if err != nil {
	// Handle error
}

The resulting connection is used to create a client which you will use for normal database requests.

// Create a client
c, err := driver.NewClient(driver.ClientConfig{
	Connection: conn,
})
if err != nil {
	// Handle error
}

Creating a Secure Connection ¶

To create a secure VST connection, use code like this.

// Create a VST over TLS connection to the database
conn, err := vst.NewConnection(vst.ConnectionConfig{
	Endpoints: []string{"https://localhost:8529"},
	TLSConfig: &tls.Config{
		InsecureSkipVerify: trueWhenUsingNonPublicCertificates,
	},
})
if err != nil {
	// Handle error
}