You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Parses the ``gel.toml``, parameters, and environment variables to
814
+
build a :dn:class:`Gel.GelConnection`.
815
+
816
+
This function will first search for the first valid primary parameters (which can set host/port)
817
+
in the following order:
818
+
819
+
- Primary parameters
820
+
- Environment variables
821
+
- ``gel.toml`` file
822
+
823
+
It will then apply any secondary args from the environment variables and options.
824
+
825
+
If any primary parameters are present, then all environment variables are ignored.
826
+
827
+
See the `documentation <https://docs.geldata.com/reference/clients/connection>`_ for more information.
828
+
829
+
:param string instance:
830
+
The name of a local instance, remote linked instance, or a Gel Cloud instance. This is a primary parameter.
831
+
832
+
:param string dsn:
833
+
/> A connection URL of the form gel://user:pass@host:port/branch. For a guide to DSNs, see the `DSN Specification <https://docs.geldata.com/reference/reference/dsn#ref-dsn>`_. This is a primary parameter.
834
+
835
+
:param string credentials:
836
+
/> The json representation of the connection. See ``T:Gel.ConnectionCredentials``. Checking in the value of this parameter could present a security risk and is not recommended. This is a primary parameter.
837
+
838
+
:param string credentialsFile:
839
+
/> The path to a json file representing a connection. See ``T:Gel.ConnectionCredentials``. Checking in the credentials file could present a security risk and is not recommended. This is a primary parameter.
840
+
841
+
:param string host:
842
+
/> The hostname of the gel instance to connect to. This is a primary parameter.
843
+
844
+
:param Nullable<int> port:
845
+
/> The port of the gel instance to connect to. This is a primary parameter.
846
+
847
+
:param string database:
848
+
/> The database name to use when connecting. Mutually exclusive with ``Gel.DocGenerator.docMemberSummaryParamref``. This is a secondary parameter.
849
+
850
+
:param string branch:
851
+
/> The branch name to use when connecting. Mutually exclusive with ``Gel.DocGenerator.docMemberSummaryParamref``. This is a secondary parameter.
852
+
853
+
:param string user:
854
+
/> The username used to connect to the database. This is a secondary parameter.
855
+
856
+
:param string password:
857
+
/> The password to connect to the database. This is a secondary parameter.
858
+
859
+
:param string secretKey:
860
+
/> The secret key used to authenticate with cloud instances. This is a secondary parameter.
861
+
862
+
:param string tlsCertificateAuthority:
863
+
/> The TLS Certificate Authority. This is a secondary parameter.
864
+
865
+
:param string tlsCertificateAuthorityFile:
866
+
/> The path to A file which contains the TLS Certificate Authority. This is a secondary parameter.
867
+
868
+
:param Nullable<TLSSecurityMode> tlsSecurity:
869
+
/> The TLS security level. This is a secondary parameter.
870
+
871
+
:param string tlsServerName:
872
+
/> The TLS server name. Overrides the hostname for TLS. This is a secondary parameter.
873
+
874
+
:param string waitUntilAvailable:
875
+
/> The number of miliseconds a client will wait for a connection to be established with the server. This is a secondary parameter.
876
+
877
+
:param Dictionary<string, string> serverSettings:
878
+
/> Additional settings for the server connection. Currently has no effect This is a secondary parameter.
879
+
880
+
:returns:
881
+
882
+
A :dn:class:`Gel.GelConnection` class that can be used to connect to a Gel instance.
883
+
884
+
:throws Gel.ConfigurationException:
885
+
An error occured while parsing or configuring the :dn:class:`Gel.GelConnection`.
0 commit comments