blob: 6eedb32ccd4190223b8b4cd414d66c7269a98a8b [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<link rel="canonical" href="https://ignite.apache.org/releases/2.5.0/dotnetdoc/api/Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class SqlConnectorConfiguration
| Apache Ignite.NET </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class SqlConnectorConfiguration
| Apache Ignite.NET ">
<meta name="generator" content="docfx 2.24.0.0">
<link rel="shortcut icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61232409-1', 'auto');
ga('send', 'pageview');
</script></head>
<body data-spy="scroll" data-target="#affix">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/logo_ignite_32_32.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items"></div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration">
<h1 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration" class="text-break">Class SqlConnectorConfiguration
</h1>
<div class="markdown level0 summary"><p>SQL connector configuration (for ODBC and JDBC).</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">SqlConnectorConfiguration</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Apache.Ignite.Core.Configuration.html">Apache.Ignite.Core.Configuration</a></h6>
<h6><strong>Assembly</strong>: Apache.Ignite.Core.dll</h6>
<h5 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Use ClientConnectorConfiguration instead.&quot;)]
public class SqlConnectorConfiguration</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration__ctor_" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.#ctor*"></a>
<h4 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration__ctor" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.#ctor">SqlConnectorConfiguration()</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.html">SqlConnectorConfiguration</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SqlConnectorConfiguration()</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<h4 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_DefaultMaxOpenCursorsPerConnection" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.DefaultMaxOpenCursorsPerConnection">DefaultMaxOpenCursorsPerConnection</h4>
<div class="markdown level1 summary"><p>Default maximum number of open cursors per connection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const int DefaultMaxOpenCursorsPerConnection = 128</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h4 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_DefaultPort" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.DefaultPort">DefaultPort</h4>
<div class="markdown level1 summary"><p>Default port.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const int DefaultPort = 10800</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h4 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_DefaultPortRange" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.DefaultPortRange">DefaultPortRange</h4>
<div class="markdown level1 summary"><p>Default port range.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const int DefaultPortRange = 100</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h4 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_DefaultSocketBufferSize" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.DefaultSocketBufferSize">DefaultSocketBufferSize</h4>
<div class="markdown level1 summary"><p>Default socket buffer size.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const int DefaultSocketBufferSize = 0</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h4 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_DefaultTcpNoDelay" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.DefaultTcpNoDelay">DefaultTcpNoDelay</h4>
<div class="markdown level1 summary"><p>Default value of <a class="xref" href="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.html#Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_TcpNoDelay">TcpNoDelay</a> property.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const bool DefaultTcpNoDelay = true</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h4 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_DefaultThreadPoolSize" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.DefaultThreadPoolSize">DefaultThreadPoolSize</h4>
<div class="markdown level1 summary"><p>Default SQL connector thread pool size.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static readonly int DefaultThreadPoolSize</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_Host_" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.Host*"></a>
<h4 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_Host" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.Host">Host</h4>
<div class="markdown level1 summary"><p>Gets or sets the host.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Host { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_MaxOpenCursorsPerConnection_" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.MaxOpenCursorsPerConnection*"></a>
<h4 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_MaxOpenCursorsPerConnection" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.MaxOpenCursorsPerConnection">MaxOpenCursorsPerConnection</h4>
<div class="markdown level1 summary"><p>Gets or sets the maximum open cursors per connection.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int MaxOpenCursorsPerConnection { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_Port_" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.Port*"></a>
<h4 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_Port" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.Port">Port</h4>
<div class="markdown level1 summary"><p>Gets or sets the port.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Port { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_PortRange_" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.PortRange*"></a>
<h4 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_PortRange" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.PortRange">PortRange</h4>
<div class="markdown level1 summary"><p>Gets or sets the port range.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int PortRange { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_SocketReceiveBufferSize_" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.SocketReceiveBufferSize*"></a>
<h4 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_SocketReceiveBufferSize" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.SocketReceiveBufferSize">SocketReceiveBufferSize</h4>
<div class="markdown level1 summary"><p>Gets or sets the size of the socket receive buffer. When set to 0, operating system default is used.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int SocketReceiveBufferSize { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_SocketSendBufferSize_" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.SocketSendBufferSize*"></a>
<h4 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_SocketSendBufferSize" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.SocketSendBufferSize">SocketSendBufferSize</h4>
<div class="markdown level1 summary"><p>Gets or sets the size of the socket send buffer. When set to 0, operating system default is used.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int SocketSendBufferSize { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_TcpNoDelay_" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.TcpNoDelay*"></a>
<h4 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_TcpNoDelay" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.TcpNoDelay">TcpNoDelay</h4>
<div class="markdown level1 summary"><p>Gets or sets the value for <code>TCP_NODELAY</code> socket option. Each
socket will be opened using provided value.
<p>
Setting this option to <code>true</code> disables Nagle&apos;s algorithm
for socket decreasing latency and delivery time for small messages.
<p>
For systems that work under heavy network load it is advisable to set this value to <code>false</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool TcpNoDelay { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_ThreadPoolSize_" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.ThreadPoolSize*"></a>
<h4 id="Apache_Ignite_Core_Configuration_SqlConnectorConfiguration_ThreadPoolSize" data-uid="Apache.Ignite.Core.Configuration.SqlConnectorConfiguration.ThreadPoolSize">ThreadPoolSize</h4>
<div class="markdown level1 summary"><p>Gets or sets the size of the thread pool.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int ThreadPoolSize { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
© 2015 - 2018 The Apache Software Foundation
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>