<?php
/*
 * Fusio
 * A web-application to create dynamically RESTful APIs
 *
 * Copyright (C) 2015-2022 Christoph Kappestein <christoph.kappestein@gmail.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace Fusio\Engine\Connection;

use Fusio\Engine\Connection\Introspection\IntrospectorInterface;

/**
 * Each connection can implement this interface in case it is possible to obtain information about the schema of the
 * service. This is mostly useful for database like connections where we can obtain i.e. a list of tables and for each
 * table we can obtain a columns. This can be useful for users of Fusio so that they can get information about the
 * schema without the need to use a different tool
 *
 * @author  Christoph Kappestein <christoph.kappestein@gmail.com>
 * @license http://www.gnu.org/licenses/agpl-3.0
 * @link    https://www.fusio-project.org
 */
interface IntrospectableInterface
{
    /**
     * Returns an introspector instance
     */
    public function getIntrospector(mixed $connection): IntrospectorInterface;
}
