Database Manual / Sharding / Reference / Inconsistency Types

CorruptedZoneShardKey

Description

CorruptedZoneShardKey

The routing table contains a zone with a min key or max key that doesn't correspond to the collection shard key.

New in version 7.0.

Format

{
   type: "CorruptedZoneShardKey",
   description: "<string>",
   details: {
      namespace: "<string>",
      collectionUUID: UUID("<uuid>"),
      zone: <zone>,
      shardKeyPattern: <pattern>
   }
}

CorruptedZoneShardKey inconsistency documents contain the following fields:

FieldTypeDescription

type

string

Type of inconsistency document. Returns a value of CorruptedZoneShardKey for this inconsistency type.

description

string

Describes the inconsistency found in the metadata.

details

document

Document with additional information on where the inconsistency exists in the database and sharded cluster.

details.namespace

string

Indicates the database and collection where the inconsistency exists.

details.collectionUUID

UUID

UUID of the collection with the corrupted zone shard key.

details.zone

document

Zone with the corrupted shard key.

details.shardKeyPattern

document

Collection shard key pattern.

Example

Use the db.adminCommand() method to call the checkMetadataConsistency command:

db.adminCommand( { checkMetadataConsistency: 1 } )

The method returns a cursor with a batch of documents showing the inconsistencies found in the sharding metadata. The example below shows a cursor with a CorruptedZoneShardKey inconsistency document:

{
   cursor: {
      id: Long("0"),
      ns: "test.$cmd.aggregate",
      firstBatch: [
         {
            type: "CorruptedZoneShardKey",
            description: "Found zone with a shard key pattern violation",
            details: {
               namespace: "test.authors",
               collection: {
                  collectionUUID : new UUID("1ad56770-61e2-48e9-83c6-8ecefe73cfc4"),
                  zone : {
                     ns : "test.authors",
                     tag: "64ddd81656be208c6685da21",
                     min: {
                        y: 0
                     },
                     max: {
                        x: MaxKey
                     }
                  },
                  shardKeyPattern: {
                     x: 1
                  }
               }
            }
         }
      ],
   },
   ok: 1
}