StreamsDB

StreamsDB

  • Join
  • Chat
  • Docs

›Reference

Introduction

  • Introduction
  • Core Concepts

Gettings started

  • CLI
  • Go
  • .NET
  • Docker Compose

Reference

  • Connection String
  • .NET Driver API reference

Legal

  • Privacy policy
  • Beta Agreement
Edit

Connection String

This document describes the URI format for defining connections between application and StreamsDB server instances.

The URI connection string scheme has the following format:

sdb://[username:password@]host[:port][/database][?options]

Examples

Connection string to host sdb-01.streamsdb.io and the database my-database

sdb://sdb-01.streamsdb.io/my-database

Connection including username and password:

sdb://demo-user:demo-password@sdb-01.streamsdb.io/my-database

Components

The URI connection string includes the following components:

ComponentDescription
sdb://A required prefix to identify that this a string in the StreamsDB URI connection string format.
username:password@optional Authentication credentials. If specified that client will attempt to log using these credentials after connecting. If the username or password includes one of the following characters: @, :, or /, use url encoding.
host[:port]The host and optional port number where the StreamsDB instance is running. You can specify a hostname, IP address of UNIX domain socket.
/databaseThe name of the database to connect to.
?optional A query string that specifies connection specific options as <name>=<value> pairs. See options for a full description of these options.

Options

The following connection string options are available:

OptionDefaultDescription
insecurefalseA boolean value to disable TLS/SSL for the connection.
blockfalseA boolean to enable or disable waiting for the connection to be established when connecting to the StreamsDB server.
gzipfalseA boolean to enable or disable gzip compression.
← Docker Compose.NET Driver API reference →
  • Examples
  • Components
  • Options
StreamsDB
Docs
Getting StartedCore conceptsReference
Community
Stack OverflowProject ChatTwitter
Code
GitHubStar
Copyright © 2019 StreamsDB