vitessio/vitess · error

GetKeyspaces: %w

Error message

GetKeyspaces: %w

What it means

CopyKeyspaces wraps errors from fromTS.GetKeyspaces(ctx) with the 'GetKeyspaces: ' prefix. This function copies all keyspace records from a source topo server to a destination topo server. The wrapped error means the source topology could not be read at all (the listing RPC failed), so the copy aborts before touching the destination.

Source

Thrown at go/vt/topo/helpers/copy.go:40

	"context"
	"fmt"

	"google.golang.org/protobuf/proto"

	"vitess.io/vitess/go/vt/log"
	"vitess.io/vitess/go/vt/sqlparser"
	"vitess.io/vitess/go/vt/topo"
	"vitess.io/vitess/go/vt/topo/topoproto"
	"vitess.io/vitess/go/vt/vtgate/vindexes"

	topodatapb "vitess.io/vitess/go/vt/proto/topodata"
)

// CopyKeyspaces will create the keyspaces in the destination topo.
func CopyKeyspaces(ctx context.Context, fromTS, toTS *topo.Server, parser *sqlparser.Parser) error {
	keyspaces, err := fromTS.GetKeyspaces(ctx)
	if err != nil {
		return fmt.Errorf("GetKeyspaces: %w", err)
	}

	for _, keyspace := range keyspaces {
		ki, err := fromTS.GetKeyspace(ctx, keyspace)
		if err != nil {
			return fmt.Errorf("GetKeyspace(%v): %w", keyspace, err)
		}

		if err := toTS.CreateKeyspace(ctx, keyspace, ki.Keyspace); err != nil {
			if topo.IsErrType(err, topo.NodeExists) {
				log.Warn(fmt.Sprintf("keyspace %v already exists", keyspace))
			} else {
				log.Error(fmt.Sprintf("CreateKeyspace(%v): %v", keyspace, err))
			}
		}

		ksvs, err := fromTS.GetVSchema(ctx, keyspace)
		switch {

View on GitHub (pinned to 01a25a7d17)

Solutions

1. Verify the source topo server (fromTS) is reachable: check topo flags/config (--topo_implementation, --topo_server, --topo_etcd_server etc.) and test connectivity.
2. Increase the context timeout / retry the copy if the deadline was exceeded.
3. Check the source topo backend (etcd/zk/k8s) health and logs for the root cause included in the wrapped error.
4. Inspect fromTS connection credentials/ACLs for read access to the keyspaces path.

Example fix

// before
keyspaces, err := fromTS.GetKeyspaces(ctx)
if err != nil {
	return fmt.Errorf("GetKeyspaces: %w", err)
}
// after (caller-side retry)
var keyspaces []string
err := retry.Do(func() error {
	var e error
	keyspaces, e = fromTS.GetKeyspaces(ctx)
	return e
}, retry.Attempts(3), retry.Delay(time.Second))
if err != nil {
	return fmt.Errorf("GetKeyspaces: %w", err)
}

if _, err := fromTS.GetKeyspaces(ctx); err != nil {
	return fmt.Errorf("source topo unreachable: %w", err)
}

keyspaces, err := fromTS.GetKeyspaces(ctx)
if err != nil {
	if ctx.Err() != nil {
		return ctx.Err()
	}
	return fmt.Errorf("GetKeyspaces: %w", err)
}

When it happens

Trigger: Calling topo/helpers.CopyKeyspaces(ctx, fromTS, toTS, parser) when fromTS.GetKeyspaces fails: source topo server unreachable, connection refused, context canceled/expired mid-list, or the global cell is corrupted or unavailable.

Common situations: Wrong vtctld/topo endpoint or port in config during topo-to-topo migrations; source etcd/zk cluster down or misconfigured; firewall blocking the topo port; context deadline too short on slow topo backends; network partitions during cluster-to-cluster copy tooling.

Related errors

• fromTS.GetKnownCells: %w
• fromTS.GetKeyspaces: %w
• cells alias %v is not valid: %v
• cell set overlaps with existing alias %v
• unknown topo protobuf type for %v

AI-assisted analysis of vitessio/vitess@01a25a7d17 (2026-09-01). Data as JSON: /api/errors/cb381539c4b74596. Report an issue: GitHub.