Documentation fix: datacenter_id does not need to be hexadecimal (#11519)

This commit is contained in:
Giuseppe 2024-07-24 21:39:53 +02:00 committed by GitHub
parent b324bfb9b9
commit 1eaf861c3a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 2 additions and 2 deletions

View File

@ -357,7 +357,7 @@ func (o DatabaseOptions) SetMachineId(param string) error {
// Specify the datacenter ID that was passed to fdbserver processes running in the same datacenter as this client, for better location-aware load balancing.
//
// Parameter: Hexadecimal ID
// Parameter: A string identifier for the datacenter
func (o DatabaseOptions) SetDatacenterId(param string) error {
return o.setOpt(22, []byte(param))
}

View File

@ -178,7 +178,7 @@ description is not currently required but encouraged.
paramType="String" paramDescription="Hexadecimal ID"
description="Specify the machine ID that was passed to fdbserver processes running on the same machine as this client, for better location-aware load balancing." />
<Option name="datacenter_id" code="22"
paramType="String" paramDescription="Hexadecimal ID"
paramType="String" paramDescription="A string identifier for the datacenter"
description="Specify the datacenter ID that was passed to fdbserver processes running in the same datacenter as this client, for better location-aware load balancing." />
<!-- The snapshot RYW options act like defaults for the equivalent transaction options, but database defaults cannot have cumulative effects from multiple calls.
Thus, we don't use the defaultFor annotation on these options. -->