<div id="docs-body">
 <div class="section">
  <div class="titlepage">
   <div>
    <div>
     <h4 class="title">
      <a name="mysql-cluster-params-api">
      </a>
      25.4.2.3 NDB Cluster SQL Node and API Node Configuration Parameters
     </h4>
    </div>
   </div>
  </div>
  <a class="indexterm" name="idm46045121455760">
  </a>
  <a class="indexterm" name="idm46045121454304">
  </a>
  <a class="indexterm" name="idm46045121453232">
  </a>
  <p>
   The listing in this section provides information about
        parameters used in the
   <code class="literal">
    [mysqld]
   </code>
   and
   <code class="literal">
    [api]
   </code>
   sections of a
   <code class="filename">
    config.ini
   </code>
   file for configuring NDB Cluster
        SQL nodes and API nodes. For detailed descriptions and other
        additional information about each of these parameters, see
   <a class="xref" href="mysql-cluster-api-definition.html" title="25.4.3.7 Defining SQL and Other API Nodes in an NDB Cluster">
    Section 25.4.3.7, “Defining SQL and Other API Nodes in an NDB Cluster”
   </a>
   .
  </p>
  <div class="itemizedlist">
   <a name="ndbparam-summary-list-api">
   </a>
   <ul class="itemizedlist" style="list-style-type: disc; ">
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-apiverbose" title="API Node Debugging Parameters">
        ApiVerbose
       </a>
      </code>
      :
            Enable NDB API debugging; for NDB development.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-arbitrationdelay">
        ArbitrationDelay
       </a>
      </code>
      :
            When asked to arbitrate, arbitrator waits this many
            milliseconds before voting.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-arbitrationrank">
        ArbitrationRank
       </a>
      </code>
      :
            If 0, then API node is not arbitrator. Kernel selects
            arbitrators in order 1, 2.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-autoreconnect">
        AutoReconnect
       </a>
      </code>
      :
            Specifies whether an API node should reconnect fully when
            disconnected from cluster.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-batchbytesize">
        BatchByteSize
       </a>
      </code>
      :
            Default batch size in bytes.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-batchsize">
        BatchSize
       </a>
      </code>
      :
            Default batch size in number of records.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-connectbackoffmaxtime">
        ConnectBackoffMaxTime
       </a>
      </code>
      :
            Specifies longest time in milliseconds (~100ms resolution)
            to allow between connection attempts to any given data node
            by this API node. Excludes time elapsed while connection
            attempts are ongoing, which in worst case can take several
            seconds. Disable by setting to 0. If no data nodes are
            currently connected to this API node,
            StartConnectBackoffMaxTime is used instead.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-connectionmap">
        ConnectionMap
       </a>
      </code>
      :
            Specifies which data nodes to connect.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-defaulthashmapsize">
        DefaultHashMapSize
       </a>
      </code>
      :
            Set size (in buckets) to use for table hash maps. Three
            values are supported: 0, 240, and 3840.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-defaultoperationredoproblemaction">
        DefaultOperationRedoProblemAction
       </a>
      </code>
      :
            How operations are handled in event that
            RedoOverCommitCounter is exceeded.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-executeoncomputer">
        ExecuteOnComputer
       </a>
      </code>
      :
            String referencing earlier defined COMPUTER.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-extrasendbuffermemory">
        ExtraSendBufferMemory
       </a>
      </code>
      :
            Memory to use for send buffers in addition to any allocated
            by TotalSendBufferMemory or SendBufferMemory. Default (0)
            allows up to 16MB.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-heartbeatthreadpriority">
        HeartbeatThreadPriority
       </a>
      </code>
      :
            Set heartbeat thread policy and priority for API nodes; see
            manual for allowed values.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-hostname">
        HostName
       </a>
      </code>
      :
            Host name or IP address for this SQL or API node.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-id">
        Id
       </a>
      </code>
      :
            Number identifying MySQL server or API node (Id). Now
            deprecated; use NodeId instead.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-locationdomainid">
        LocationDomainId
       </a>
      </code>
      :
            Assign this API node to specific availability domain or
            zone. 0 (default) leaves this unset.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-maxscanbatchsize">
        MaxScanBatchSize
       </a>
      </code>
      :
            Maximum collective batch size for one scan.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-nodeid">
        NodeId
       </a>
      </code>
      :
            Number uniquely identifying SQL node or API node among all
            nodes in cluster.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-startconnectbackoffmaxtime">
        StartConnectBackoffMaxTime
       </a>
      </code>
      :
            Same as ConnectBackoffMaxTime except that this parameter is
            used in its place if no data nodes are connected to this API
            node.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-totalsendbuffermemory">
        TotalSendBufferMemory
       </a>
      </code>
      :
            Total memory to use for all transporter send buffers.
     </p>
    </li>
    <li class="listitem">
     <p>
      <code class="literal">
       <a class="link" href="mysql-cluster-api-definition.html#ndbparam-api-wan">
        wan
       </a>
      </code>
      :
            Use WAN TCP setting as default.
     </p>
    </li>
   </ul>
  </div>
  <p>
   For a discussion of MySQL server options for NDB Cluster, see
   <a class="xref" href="mysql-cluster-options-variables.html#mysql-cluster-program-options-mysqld" title="25.4.3.9.1 MySQL Server Options for NDB Cluster">
    Section 25.4.3.9.1, “MySQL Server Options for NDB Cluster”
   </a>
   . For
        information about MySQL server system variables relating to NDB
        Cluster, see
   <a class="xref" href="mysql-cluster-options-variables.html#mysql-cluster-system-variables" title="25.4.3.9.2 NDB Cluster System Variables">
    Section 25.4.3.9.2, “NDB Cluster System Variables”
   </a>
   .
  </p>
  <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
   <div class="admon-title">
    Note
   </div>
   <p>
    To add new SQL or API nodes to the configuration of a running
          NDB Cluster, it is necessary to perform a rolling restart of
          all cluster nodes after adding new
    <code class="literal">
     [mysqld]
    </code>
    or
    <code class="literal">
     [api]
    </code>
    sections to the
    <code class="filename">
     config.ini
    </code>
    file (or files, if you are
          using more than one management server). This must be done
          before the new SQL or API nodes can connect to the cluster.
   </p>
   <p>
    It is
    <span class="emphasis">
     <em>
      not
     </em>
    </span>
    necessary to perform any
          restart of the cluster if new SQL or API nodes can employ
          previously unused API slots in the cluster configuration to
          connect to the cluster.
   </p>
  </div>
 </div>
 <br/>
</div>
