Files
clio/tests/integration/migration/cassandra/ExampleLedgerMigrator.hpp
cyan317 f64d8ecb77 fix: Copyright format (#1835)
Aligned the copyright notice to match the format used in other files.
Updated Copyright (c) 2022-2024 to Copyright (c) 2024 to ensure
consistency.
2025-01-16 14:36:03 +00:00

42 lines
1.9 KiB
C++

//------------------------------------------------------------------------------
/*
This file is part of clio: https://github.com/XRPLF/clio
Copyright (c) 2024, the clio developers.
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
#pragma once
#include "migration/cassandra/CassandraMigrationTestBackend.hpp"
#include "util/newconfig/ObjectView.hpp"
#include <memory>
/**
* @brief Example migrator for the ledgers table. In this example, we show how to migrate the data from table without
* full table scan. We create an index table called "ledger_example" which maintains the map of ledger
* sequence to account hash. Because ledger sequence is the partition key of ledgers table, we can just fetch the data
* via ledger sequence without full table scan.
*/
struct ExampleLedgerMigrator {
static constexpr char const* kNAME = "ExampleLedgerMigrator";
static constexpr char const* kDESCRIPTION = "The migrator for ledgers table";
using Backend = CassandraMigrationTestBackend;
static void
runMigration(std::shared_ptr<Backend> const& backend, util::config::ObjectView const& config);
};