---

gql++/database-metadata.h

Go to the documentation of this file.

/* This is for emacs: -*-Mode: C++;-*- */
#if !defined(__INC_DATABASE_METADATA_H)
#define __INC_DATABASE_METADATA_H

#include "gql++/result-set.h"

namespace GQL
{

class DatabaseMetaData : public Yehia::Object
{
  public:
    enum ImportedKeyUpdateRule
    {
      ImportedKeyNoAction,
      ImportedKeySetDefault,
      ImportedKeySetNull,
      ImportedKeyCascade,
      ImportedKeyRestrict
    };
    
    enum ImportedKeyDeferrability
    {
      ImportedKeyInitiallyDeferred,
      ImportedKeyInitiallyImmediate,
      ImportedKeyNotDeferrable
    };

    enum ColumnNullability
    {
      ColumnNoNulls, 
      ColumnNullable, 
      ColumnNullableUnknown 
    };

    enum TableIndexType
    {
      TableIndexStatistic,
      TableIndexClustered,
      TableIndexHashed,
      TableIndexOther
    };

    virtual ResultSet *get_tables(const std::string& catalog,
                                  const std::string& schema,
                                  const std::string& table_name_pattern,
                                  const std::vector<std::string>& types) = 0;
    
    /* Get information about table columns. 
     * 
     * \return ResultSet of column descriptions, having the following
     *   columns:
     * <ul>
     *   <li>0. \b TABLE_CAT String => table catalog (may be null)
     *   <li>1. \b TABLE_SCHEM String => table schema (may be null)
     *   <li>2. \b TABLE_NAME String => table name
     *   <li>3. \b COLUMN_NAME String => column name
     *   <li>4. \b DATA_TYPE SQLType => data type
     *   <li>5. \b NULLABLE ColumnNullability => is NULL allowed.
     *   <li>6. REMARKS String => comment describing column (may be null)
     *   <li>7. COLUMN_DEF String => default value (may be null)
     *   <li>8. ORDINAL_POSITION int => index of column in table 
     *       (starting at 0)
     *   </ul> */
    virtual ResultSet *get_columns(const std::string& catalog,
                                   const std::string& schema,
                                   const std::string& table_name_pattern,
                                   const std::string& column_name_pattern) = 0;

    virtual ResultSet *get_primary_keys(const std::string& catalog,
                                        const std::string& schema,
                                        const std::string& table) = 0;

    virtual ResultSet *get_cross_reference(
            const std::string& primary_catalog,
            const std::string& primary_schema,
            const std::string& primary_table,
            const std::string& foreign_catalog,
            const std::string& foreign_schema,
            const std::string& foreign_table) = 0;

    virtual ResultSet *get_imported_keys(const std::string& catalog,
                                         const std::string& schema,
                                         const std::string& table) = 0;
    
    virtual ResultSet *get_exported_keys(const std::string& catalog,
                                         const std::string& schema,
                                         const std::string& table) = 0;

    virtual ResultSet *get_index_info(const std::string& catalog,
                                      const std::string& schema,
                                      const std::string& table,
                                      bool unique,
                                      bool approximate) = 0;
};

}

#endif

---