SchemaRegistry.h

浏览该文件的文档.

#pragma once
#include "common/Export.h"
 
#include "common/Result.h"
#include "common/Value.h"
#include "schema/SchemaTypes.h"
 
#include <functional>
#include <string>
#include <vector>
 
namespace eve::schema {
 
using MigrationFunction = std::function<eve::Result<eve::Value>(const eve::Value& input)>;
 
struct EVENGINE_API_FOUNDATION_INLINE SchemaCompatibility {
    std::string      schemaId;
    int              fromVersion = 0;
    int              toVersion   = 0;
    std::vector<int> versions;
 
    [[nodiscard]] bool exact() const noexcept { return versions.size() == 1; }
};
 
class EVENGINE_API_FOUNDATION SchemaRegistry {
public:
    [[nodiscard]] static eve::Result<SchemaRegistrationStatus> registerSchema(const SchemaDefinition& definition);
 
    [[nodiscard]] static eve::Result<SchemaRegistrationStatus> registerFromJson(const std::string& json);
 
    [[nodiscard]] static eve::Result<SchemaRegistrationStatus> registerVersioned(const SchemaDefinition& definition);
 
    [[nodiscard]] static eve::Result<SchemaRegistrationStatus> registerFromJsonVersioned(const std::string& json);
 
    [[nodiscard]] static const SchemaDefinition* find(const std::string& id);
 
    [[nodiscard]] static const SchemaDefinition* resolve(const std::string& schemaId, int schemaVersion);
 
    [[nodiscard]] static std::vector<int> versions(const std::string& schemaId);
 
    [[nodiscard]] static eve::Result<void> remove(const std::string& id);
 
    [[nodiscard]] static eve::Result<void> remove(const std::string& id, int schemaVersion);
 
    static void clear();
 
    static int count();
 
    static int versionCount();
 
    static std::vector<std::string> ids();
 
    [[nodiscard]] static std::vector<ValidationError> validate(const std::string& schemaId, const std::string& json);
 
    [[nodiscard]] static std::vector<ValidationError> validate(const std::string& schemaId, int schemaVersion,
                                                               const std::string& json);
 
    [[nodiscard]] static eve::Result<void> registerMigration(const std::string& schemaId, int fromVersion,
                                                             int toVersion, MigrationFunction migration);
 
    [[nodiscard]] static eve::Result<SchemaCompatibility> queryCompatibility(const std::string& schemaId,
                                                                             int fromVersion, int toVersion);
 
    [[nodiscard]] static eve::Result<eve::Value> migrate(const std::string& schemaId, int fromVersion, int toVersion,
                                                         const eve::Value& input);
 
    [[nodiscard]] static eve::Result<std::string> migrateJson(const std::string& schemaId, int fromVersion,
                                                              int toVersion, const std::string& json);
 
    [[nodiscard]] static eve::Result<std::string> generateDocumentation(const std::string& schemaId, int schemaVersion);
 
    [[nodiscard]] static eve::Result<std::string> generateBindingContract(const std::string& schemaId,
                                                                          int                schemaVersion);
};
 
}  // namespace eve::schema