Documentation Home
MySQL 5.6 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 31.1Mb
PDF (A4) - 31.1Mb
PDF (RPM) - 29.3Mb
HTML Download (TGZ) - 7.2Mb
HTML Download (Zip) - 7.2Mb
HTML Download (RPM) - 6.2Mb
Man Pages (TGZ) - 175.8Kb
Man Pages (Zip) - 286.0Kb
Info (Gzip) - 3.0Mb
Info (Zip) - 3.0Mb
Excerpts from this Manual

18.3.3.11 NDB Cluster Shared-Memory Connections

NDB Cluster attempts to use the shared memory transporter and configure it automatically where possible. [shm] sections in the config.ini file explicitly define shared-memory connections between nodes in the cluster. When explicitly defining shared memory as the connection method, it is necessary to define at least NodeId1, NodeId2, and ShmKey. All other parameters have default values that should work well in most cases.

Important

SHM functionality is considered experimental only. It is not officially supported in any current NDB Cluster release, and testing results indicate that SHM performance is not appreciably greater than when using TCP/IP for the transporter.

For these reasons, you must determine for yourself or by using our free resources (forums, mailing lists) whether SHM can be made to work correctly in your specific case.

Restart types.  Information about the restart types used by the parameter descriptions in this section is shown in the following table:

Table 18.276 NDB Cluster restart types

Symbol Restart Type Description
N Node The parameter can be updated using a rolling restart (see Section 18.5.5, “Performing a Rolling Restart of an NDB Cluster”)
S System All cluster nodes must be shut down completely, then restarted, to effect a change in this parameter
I Initial Data nodes must be restarted using the --initial option

  • Checksum

    Table 18.277 This table provides type and value information for the Checksum shared memory configuration parameter

    Property Value
    Version (or later) NDB 7.3.1
    Type or units boolean
    Default true
    Range true, false
    Restart Type N

    This parameter is a boolean (Y/N) parameter which is disabled by default. When it is enabled, checksums for all messages are calculated before being placed in the send buffer.

    This feature prevents messages from being corrupted while waiting in the send buffer. It also serves as a check against data being corrupted during transport.

  • HostName1

    Table 18.278 This table provides type and value information for the HostName1 shared memory configuration parameter

    Property Value
    Version (or later) NDB 7.3.1
    Type or units name or IP address
    Default [none]
    Range ...
    Restart Type N

    The HostName1 and HostName2 parameters can be used to specify specific network interfaces to be used for a given SHM connection between two nodes. The values used for these parameters can be host names or IP addresses.

  • HostName2

    Table 18.279 This table provides type and value information for the HostName1 shared memory configuration parameter

    Property Value
    Version (or later) NDB 7.3.1
    Type or units name or IP address
    Default [none]
    Range ...
    Restart Type N

    The HostName1 and HostName2 parameters can be used to specify specific network interfaces to be used for a given SHM connection between two nodes. The values used for these parameters can be host names or IP addresses.

  • NodeId1

    Table 18.280 This table provides type and value information for the NodeId1 shared memory configuration parameter

    Property Value
    Version (or later) NDB 7.3.1
    Type or units numeric
    Default [none]
    Range 1 - 255
    Restart Type N

    To identify a connection between two nodes it is necessary to provide node identifiers for each of them, as NodeId1 and NodeId2.

  • NodeId2

    Table 18.281 This table provides type and value information for the NodeId2 shared memory configuration parameter

    Property Value
    Version (or later) NDB 7.3.1
    Type or units numeric
    Default [none]
    Range 1 - 255
    Restart Type N

    To identify a connection between two nodes it is necessary to provide node identifiers for each of them, as NodeId1 and NodeId2.

  • NodeIdServer

    Table 18.282 This table provides type and value information for the NodeIdServer shared memory configuration parameter

    Property Value
    Version (or later) NDB 7.3.1
    Type or units numeric
    Default [none]
    Range 1 - 63
    Restart Type N

    Identify the server end of a shared memory connection.

  • OverloadLimit

    Table 18.283 This table provides type and value information for the OverloadLimit shared memory configuration parameter

    Property Value
    Version (or later) NDB 7.3.1
    Type or units bytes
    Default 0
    Range 0 - 4294967039 (0xFFFFFEFF)
    Restart Type N

    When more than this many unsent bytes are in the send buffer, the connection is considered overloaded.

    This parameter can be used to determine the amount of unsent data that must be present in the send buffer before the connection is considered overloaded. See Section 18.3.3.13, “Configuring NDB Cluster Send Buffer Parameters”, for more information.

  • SendSignalId

    Table 18.284 This table provides type and value information for the SendSignalId shared memory configuration parameter

    Property Value
    Version (or later) NDB 7.3.1
    Type or units boolean
    Default false
    Range true, false
    Restart Type N

    To retrace the path of a distributed message, it is necessary to provide each message with a unique identifier. Setting this parameter to Y causes these message IDs to be transported over the network as well. This feature is disabled by default in production builds, and enabled in -debug builds.

  • ShmKey

    Table 18.285 This table provides type and value information for the ShmKey shared memory configuration parameter

    Property Value
    Version (or later) NDB 7.3.1
    Type or units unsigned
    Default 0
    Range 0 - 4294967039 (0xFFFFFEFF)
    Restart Type N

    When setting up shared memory segments, a node ID, expressed as an integer, is used to identify uniquely the shared memory segment to use for the communication. There is no default value.

  • ShmSize

    Table 18.286 This table provides type and value information for the ShmSize shared memory configuration parameter

    Property Value
    Version (or later) NDB 7.3.1
    Type or units bytes
    Default 1M
    Range 64K - 4294967039 (0xFFFFFEFF)
    Restart Type N

    Each SHM connection has a shared memory segment where messages between nodes are placed by the sender and read by the reader. The size of this segment is defined by ShmSize. The default value is 1MB.

  • SigNum

    Table 18.287 This table provides type and value information for the Signum shared memory configuration parameter

    Property Value
    Version (or later) NDB 7.3.1
    Type or units unsigned
    Default [none]
    Range 0 - 4294967039 (0xFFFFFEFF)
    Restart Type N

    When using the shared memory transporter, a process sends an operating system signal to the other process when there is new data available in the shared memory. Should that signal conflict with an existing signal, this parameter can be used to change it. This is a possibility when using SHM due to the fact that different operating systems use different signal numbers.

    The default value of SigNum is 0; therefore, it must be set to avoid errors in the cluster log when using the shared memory transporter. Typically, this parameter is set to 10 in the [shm default] section of the config.ini file.


User Comments
User comments in this section are, as the name implies, provided by MySQL users. The MySQL documentation team is not responsible for, nor do they endorse, any of the information provided here.
Sign Up Login You must be logged in to post a comment.