btrdb¶
Package for the btrdb database library.
-
btrdb.connect(conn_str=None, apikey=None, profile=None)¶ Connect to a BTrDB server.
Parameters: - conn_str (str, default=None) – The address and port of the cluster to connect to, e.g. 192.168.1.1:4411. If set to None, will look in the environment variable $BTRDB_ENDPOINTS (recommended).
- apikey (str, default=None) – The API key used to authenticate requests (optional). If None, the key is looked up from the environment variable $BTRDB_API_KEY.
- profile (str, default=None) – The name of a profile containing the required connection information as found in the user’s predictive grid credentials file ~/.predictivegrid/credentials.yaml.
Returns: db – An instance of the BTrDB context to directly interact with the database.
Return type: