Class DeephavenConnectionStringBuilder

A strongly typed connection string builder for Deephaven connections.

Inheritance

System.Object

DeephavenConnectionStringBuilder

Namespace: Deephaven.Connector

Assembly: Deephaven.Connector.dll

Syntax

public class DeephavenConnectionStringBuilder : DbConnectionStringBuilder

Constructors

DeephavenConnectionStringBuilder()

Initializes a new instance of the DeephavenConnectionStringBuilder class.

Declaration

public DeephavenConnectionStringBuilder()

DeephavenConnectionStringBuilder(Boolean)

Initializes a new instance of the DeephavenConnectionStringBuilder class, optionally using ODBC rules for quoting values.

Declaration

public DeephavenConnectionStringBuilder(bool useOdbcRules)

Parameters

Type	Name	Description
System.Boolean	useOdbcRules	true to use {} to delimit fields; false to use quotation marks.

DeephavenConnectionStringBuilder(String)

Initializes a new instance of the DeephavenConnectionStringBuilder class with the given connection string.

Declaration

public DeephavenConnectionStringBuilder(string connectionString)

Parameters

Type	Name	Description
System.String	connectionString

Properties

Host

The hostname or IP address of the WebAPI server.

Declaration

public string Host { get; set; }

Property Value

Type	Description
System.String

Item[String]

Gets or sets the value associated with the specified key.

Declaration

public override object this[string keyword] { get; set; }

Parameters

Type	Name	Description
System.String	keyword	The key of the item to get or set.

Property Value

Type	Description
System.Object	The value associated with the specified key.

Keys

Gets an ICollection{string} containing the keys of the DeephavenConnectionStringBuilder.

Declaration

public ICollection<string> Keys { get; }

Property Value

Type	Description
ICollection<System.String>

LocalDateAsString

Whether to return LocalDate column data as strings instead of DateTime.

Declaration

public bool LocalDateAsString { get; set; }

Property Value

Type	Description
System.Boolean

LocalTimeAsString

Whether to return LocalTime column data as strings instead of DateTime.

Declaration

public bool LocalTimeAsString { get; set; }

Property Value

Type	Description
System.Boolean

MaxHeapMb

Maximum heap size for worker process in MB.

Declaration

public int MaxHeapMb { get; set; }

Property Value

Type	Description
System.Int32

OperateAs

The user to operate-as.

Declaration

public string OperateAs { get; set; }

Property Value

Type	Description
System.String

Password

The password to connect with.

Declaration

public string Password { get; set; }

Property Value

Type	Description
System.String

Port

The TCP/IP port of the WebAPI server.

Declaration

public int Port { get; set; }

Property Value

Type	Description
System.Int32

RemoteDebugPort

Port on which the server process should bind on for debugging

Declaration

public int RemoteDebugPort { get; set; }

Property Value

Type	Description
System.Int32

SessionType

The query session type.

Declaration

public SessionType SessionType { get; set; }

Property Value

Type	Description
SessionType

SuspendWorker

Whether the worker process should suspend and wait for a debugger on startup.

Declaration

public bool SuspendWorker { get; set; }

Property Value

Type	Description
System.Boolean

TimeoutMs

Connection timeout in milliseconds.

Declaration

public int TimeoutMs { get; set; }

Property Value

Type	Description
System.Int32

Username

The username to connect with.

Declaration

public string Username { get; set; }

Property Value

Type	Description
System.String

Values

Gets an ICollection{string} containing the values in the DeephavenConnectionStringBuilder.

Declaration

public ICollection<object> Values { get; }

Property Value

Type	Description
ICollection<System.Object>

Methods

Add(KeyValuePair<String, Object>)

Adds an item to the DeephavenConnectionStringBuilder.

Declaration

public void Add(KeyValuePair<string, object> item)

Parameters

Type	Name	Description
KeyValuePair<System.String, System.Object>	item	The key-value pair to be added.

Clear()

Clears the contents of the DeephavenConnectionStringBuilder instance.

Declaration

public override void Clear()

Contains(KeyValuePair<String, Object>)

Determines whether the DeephavenConnectionStringBuilder contains a specific key-value pair.

Declaration

public bool Contains(KeyValuePair<string, object> item)

Parameters

Type	Name	Description
KeyValuePair<System.String, System.Object>	item	The item to locate in the DeephavenConnectionStringBuilder.

Returns

Type	Description
System.Boolean	true if the DeephavenConnectionStringBuilder contains the entry; otherwise false.

ContainsKey(String)

Determines whether the DeephavenConnectionStringBuilder contains a specific key.

Declaration

public override bool ContainsKey(string keyword)

Parameters

Type	Name	Description
System.String	keyword	The key to locate in the DeephavenConnectionStringBuilder.

Returns

Type	Description
System.Boolean	true if the DeephavenConnectionStringBuilder contains an entry with the specified key; otherwise false.

CopyTo(KeyValuePair<String, Object>[], Int32)

Copies the elements of the DeephavenConnectionStringBuilder to an Array, starting at a particular Array index.

Declaration

public void CopyTo(KeyValuePair<string, object>[] array, int arrayIndex)

Parameters

Type	Name	Description
KeyValuePair<System.String, System.Object>[]	array	The one-dimensional Array that is the destination of the elements copied from DeephavenConnectionStringBuilder. The Array must have zero-based indexing.
System.Int32	arrayIndex	The zero-based index in array at which copying begins.

Equals(Object)

Determines whether the specified object is equal to the current object.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

GetEnumerator()

Returns an enumerator that iterates through the DeephavenConnectionStringBuilder.

Declaration

public IEnumerator<KeyValuePair<string, object>> GetEnumerator()

Returns

Type	Description
IEnumerator<KeyValuePair<System.String, System.Object>>

GetHashCode()

Hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

GetProperties(Hashtable)

Declaration

protected override void GetProperties(Hashtable propertyDescriptors)

Parameters

Type	Name	Description
Hashtable	propertyDescriptors

Remove(KeyValuePair<String, Object>)

Removes the entry from the DbConnectionStringBuilder instance.

Declaration

public bool Remove(KeyValuePair<string, object> item)

Parameters

Type	Name	Description
KeyValuePair<System.String, System.Object>	item	The key/value pair to be removed from the connection string in this DbConnectionStringBuilder.

Returns

Type	Description
System.Boolean	true if the key existed within the connection string and was removed; false if the key did not exist.

Remove(String)

Removes the entry with the specified key from the DbConnectionStringBuilder instance.

Declaration

public override bool Remove(string keyword)

Parameters

Type	Name	Description
System.String	keyword	The key of the key/value pair to be removed from the connection string in this DbConnectionStringBuilder.

Returns

Type	Description
System.Boolean	true if the key existed within the connection string and was removed; false if the key did not exist.

TryGetValue(String, out Object)

Retrieves a value corresponding to the supplied key from this DeephavenConnectionStringBuilder.

Declaration

public override bool TryGetValue(string keyword, out object value)

Parameters

Type	Name	Description
System.String	keyword	The key of the item to retrieve.
System.Object	value	The value corresponding to the key.

Returns

Type	Description
System.Boolean	true if keyword was found within the connection string, false otherwise.