include/paimon/catalog/database.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 <map>
#include <memory>
#include <optional>
#include <string>
#include <vector>

#include "paimon/result.h"
#include "paimon/status.h"
#include "paimon/type_fwd.h"
#include "paimon/visibility.h"

struct ArrowSchema;

namespace paimon {

/// Interface of a database in a catalog.
class PAIMON_EXPORT Database {
 public:
    virtual ~Database() = default;

    /// ================== Database Metadata =====================

    /// A name to identify this database.
    virtual std::string Name() const = 0;

    /// Get the database-level options associated with this database.
    /// @return Options
    virtual const std::map<std::string, std::string>& Options() const = 0;

    /// Get an optional comment describing the database.
    /// @return The database comment if set, or std::nullopt otherwise.
    virtual std::optional<std::string> Comment() const = 0;
};

}  // namespace paimon