src/types/redis_json.h

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 */

#pragma once

#include <storage/redis_db.h>

#include <string>

#include "json.h"
#include "server/redis_reply.h"
#include "storage/redis_metadata.h"

namespace redis {

class Json : public Database {
 public:
  Json(engine::Storage *storage, std::string ns) : Database(storage, std::move(ns)) {}

  rocksdb::Status Set(engine::Context &ctx, const std::string &user_key, const std::string &path,
                      const std::string &value);
  rocksdb::Status Get(engine::Context &ctx, const std::string &user_key, const std::vector<std::string> &paths,
                      JsonValue *result);
  rocksdb::Status Info(engine::Context &ctx, const std::string &user_key, JsonStorageFormat *storage_format);
  rocksdb::Status Type(engine::Context &ctx, const std::string &user_key, const std::string &path,
                       std::vector<std::string> *results);
  rocksdb::Status ArrAppend(engine::Context &ctx, const std::string &user_key, const std::string &path,
                            const std::vector<std::string> &values, Optionals<size_t> *results);
  rocksdb::Status Merge(engine::Context &ctx, const std::string &user_key, const std::string &path,
                        const std::string &value, bool &result);
  rocksdb::Status Clear(engine::Context &ctx, const std::string &user_key, const std::string &path, size_t *result);
  rocksdb::Status ArrLen(engine::Context &ctx, const std::string &user_key, const std::string &path,
                         Optionals<uint64_t> *results);
  rocksdb::Status ArrInsert(engine::Context &ctx, const std::string &user_key, const std::string &path,
                            const int64_t &index, const std::vector<std::string> &values, Optionals<uint64_t> *results);
  rocksdb::Status Toggle(engine::Context &ctx, const std::string &user_key, const std::string &path,
                         Optionals<bool> *results);
  rocksdb::Status ObjKeys(engine::Context &ctx, const std::string &user_key, const std::string &path,
                          Optionals<std::vector<std::string>> *keys);
  rocksdb::Status ArrPop(engine::Context &ctx, const std::string &user_key, const std::string &path, int64_t index,
                         std::vector<std::optional<JsonValue>> *results);
  rocksdb::Status ArrIndex(engine::Context &ctx, const std::string &user_key, const std::string &path,
                           const std::string &needle, ssize_t start, ssize_t end, Optionals<ssize_t> *results);
  rocksdb::Status NumIncrBy(engine::Context &ctx, const std::string &user_key, const std::string &path,
                            const std::string &value, JsonValue *result);
  rocksdb::Status NumMultBy(engine::Context &ctx, const std::string &user_key, const std::string &path,
                            const std::string &value, JsonValue *result);

  rocksdb::Status ArrTrim(engine::Context &ctx, const std::string &user_key, const std::string &path, int64_t start,
                          int64_t stop, Optionals<uint64_t> *results);
  rocksdb::Status Del(engine::Context &ctx, const std::string &user_key, const std::string &path, size_t *result);
  rocksdb::Status StrAppend(engine::Context &ctx, const std::string &user_key, const std::string &path,
                            const std::string &value, Optionals<uint64_t> *results);
  rocksdb::Status StrLen(engine::Context &ctx, const std::string &user_key, const std::string &path,
                         Optionals<uint64_t> *results);
  rocksdb::Status ObjLen(engine::Context &ctx, const std::string &user_key, const std::string &path,
                         Optionals<uint64_t> *results);

  std::vector<rocksdb::Status> MGet(engine::Context &ctx, const std::vector<std::string> &user_keys,
                                    const std::string &path, std::vector<JsonValue> &results);
  rocksdb::Status MSet(engine::Context &ctx, const std::vector<std::string> &user_keys,
                       const std::vector<std::string> &paths, const std::vector<std::string> &values);
  rocksdb::Status DebugMemory(engine::Context &ctx, const std::string &user_key, const std::string &path,
                              std::vector<size_t> *results);

  rocksdb::Status Resp(engine::Context &ctx, const std::string &user_key, const std::string &path,
                       std::vector<std::string> *results, RESP resp);
  static rocksdb::Status FromRawString(std::string_view value, JsonValue *result);

 private:
  rocksdb::Status write(engine::Context &ctx, Slice ns_key, JsonMetadata *metadata, const JsonValue &json_val);
  rocksdb::Status read(engine::Context &ctx, const Slice &ns_key, JsonMetadata *metadata, JsonValue *value);
  static rocksdb::Status parse(const JsonMetadata &metadata, const Slice &json_byte, JsonValue *value);
  rocksdb::Status create(engine::Context &ctx, const std::string &ns_key, JsonMetadata &metadata,
                         const std::string &value);
  rocksdb::Status del(engine::Context &ctx, const Slice &ns_key);
  rocksdb::Status numop(engine::Context &ctx, JsonValue::NumOpEnum op, const std::string &user_key,
                        const std::string &path, const std::string &value, JsonValue *result);
  std::vector<rocksdb::Status> readMulti(engine::Context &ctx, const std::vector<Slice> &ns_keys,
                                         std::vector<JsonValue> &values);

  friend struct FieldValueRetriever;
};

}  // namespace redis