// DecodeTableIDIndexID decodes a table id followed by an index id. func DecodeTableIDIndexID(key []byte) ([]byte, ID, IndexID, error) { var tableID uint64 var indexID uint64 var err error key, tableID, err = encoding.DecodeUvarintAscending(key) if err != nil { return nil, 0, 0, err } key, indexID, err = encoding.DecodeUvarintAscending(key) if err != nil { return nil, 0, 0, err } return key, ID(tableID), IndexID(indexID), nil }
// ObjectIDForKey returns the object ID (table or database) for 'key', // or (_, false) if not within the structured key space. func ObjectIDForKey(key roachpb.RKey) (uint32, bool) { if key.Equal(roachpb.RKeyMax) { return 0, false } if encoding.PeekType(key) != encoding.Int { // TODO(marc): this should eventually return SystemDatabaseID. return 0, false } // Consume first encoded int. _, id64, err := encoding.DecodeUvarintAscending(key) return uint32(id64), err == nil }
func decodeDescMetadataID(key roachpb.Key) (uint64, error) { // Extract object ID from key. // TODO(marc): move sql/keys.go to keys (or similar) and use a DecodeDescMetadataKey. // We should also check proper encoding. remaining, tableID, err := keys.DecodeTablePrefix(key) if err != nil { return 0, err } if tableID != keys.DescriptorTableID { return 0, errors.Errorf("key is not a descriptor table entry: %v", key) } // DescriptorTable.PrimaryIndex.ID remaining, _, err = encoding.DecodeUvarintAscending(remaining) if err != nil { return 0, err } // descID _, id, err := encoding.DecodeUvarintAscending(remaining) if err != nil { return 0, err } return id, nil }
// DecodeRangeIDKey parses a local range ID key into range ID, infix, // suffix, and detail. func DecodeRangeIDKey( key roachpb.Key, ) (rangeID roachpb.RangeID, infix, suffix, detail roachpb.Key, err error) { if !bytes.HasPrefix(key, LocalRangeIDPrefix) { return 0, nil, nil, nil, errors.Errorf("key %s does not have %s prefix", key, LocalRangeIDPrefix) } // Cut the prefix, the Range ID, and the infix specifier. b := key[len(LocalRangeIDPrefix):] b, rangeInt, err := encoding.DecodeUvarintAscending(b) if err != nil { return 0, nil, nil, nil, err } if len(b) < localSuffixLength+1 { return 0, nil, nil, nil, errors.Errorf("malformed key does not contain range ID infix and suffix") } infix = b[:1] b = b[1:] suffix = b[:localSuffixLength] b = b[localSuffixLength:] return roachpb.RangeID(rangeInt), infix, suffix, b, nil }
// EnsureSafeSplitKey transforms an SQL table key such that it is a valid split key // (i.e. does not occur in the middle of a row). func EnsureSafeSplitKey(key roachpb.Key) (roachpb.Key, error) { if encoding.PeekType(key) != encoding.Int { // Not a table key, so already a split key. return key, nil } n := len(key) // The column ID length is encoded as a varint and we take advantage of the // fact that the column ID itself will be encoded in 0-9 bytes and thus the // length of the column ID data will fit in a single byte. buf := key[n-1:] if encoding.PeekType(buf) != encoding.Int { // The last byte is not a valid column ID suffix. return nil, errors.Errorf("%s: not a valid table key", key) } // Strip off the family ID / column ID suffix from the buf. The last byte of the buf // contains the length of the column ID suffix (which might be 0 if the buf // does not contain a column ID suffix). _, colIDLen, err := encoding.DecodeUvarintAscending(buf) if err != nil { return nil, err } if int(colIDLen)+1 > n { // The column ID length was impossible. colIDLen is the length of // the encoded column ID suffix. We add 1 to account for the byte // holding the length of the encoded column ID and if that total // (colIDLen+1) is greater than the key suffix (n == len(buf)) // then we bail. Note that we don't consider this an error because // EnsureSafeSplitKey can be called on keys that look like table // keys but which do not have a column ID length suffix (e.g // SystemConfig.ComputeSplitKeys). return nil, errors.Errorf("%s: malformed table key", key) } return key[:len(key)-int(colIDLen)-1], nil }
// DecodeTablePrefix validates that the given key has a table prefix, returning // the remainder of the key (with the prefix removed) and the decoded descriptor // ID of the table. func DecodeTablePrefix(key roachpb.Key) ([]byte, uint64, error) { if encoding.PeekType(key) != encoding.Int { return key, 0, errors.Errorf("invalid key prefix: %q", key) } return encoding.DecodeUvarintAscending(key) }
// ProcessKV processes the given key/value, setting values in the row // accordingly. If debugStrings is true, returns pretty printed key and value // information in prettyKey/prettyValue (otherwise they are empty strings). func (rf *RowFetcher) ProcessKV( kv client.KeyValue, debugStrings bool, ) (prettyKey string, prettyValue string, err error) { if debugStrings { prettyKey = fmt.Sprintf("/%s/%s%s", rf.desc.Name, rf.index.Name, prettyEncDatums(rf.keyVals)) } if rf.indexKey == nil { // This is the first key for the row. rf.indexKey = []byte(kv.Key[:len(kv.Key)-len(rf.keyRemainingBytes)]) // Reset the row to nil; it will get filled in with the column // values as we decode the key-value pairs for the row. for i := range rf.row { rf.row[i].UnsetDatum() } // Fill in the column values that are part of the index key. for i, v := range rf.keyVals { rf.row[rf.indexColIdx[i]] = v } } if !rf.isSecondaryIndex && len(rf.keyRemainingBytes) > 0 { _, familyID, err := encoding.DecodeUvarintAscending(rf.keyRemainingBytes) if err != nil { return "", "", err } family, err := rf.desc.FindFamilyByID(FamilyID(familyID)) if err != nil { return "", "", err } switch kv.Value.GetTag() { case roachpb.ValueType_TUPLE: prettyKey, prettyValue, err = rf.processValueTuple(family, kv, debugStrings, prettyKey) default: prettyKey, prettyValue, err = rf.processValueSingle(family, kv, debugStrings, prettyKey) } if err != nil { return "", "", err } } else { if rf.implicitVals != nil { // This is a unique index; decode the implicit column values from // the value. _, err := DecodeKeyVals(&rf.alloc, rf.implicitVals, nil, kv.ValueBytes()) if err != nil { return "", "", err } for i, id := range rf.index.ImplicitColumnIDs { if idx, ok := rf.colIdxMap[id]; ok && rf.valNeededForCol[idx] { rf.row[idx] = rf.implicitVals[i] } } if debugStrings { prettyValue = prettyEncDatums(rf.implicitVals) } } if log.V(2) { if rf.implicitVals != nil { log.Infof(context.TODO(), "Scan %s -> %s", kv.Key, prettyEncDatums(rf.implicitVals)) } else { log.Infof(context.TODO(), "Scan %s", kv.Key) } } } if debugStrings && prettyValue == "" { prettyValue = parser.DNull.String() } return prettyKey, prettyValue, nil }