Module: OCI8::Metadata

Defined in:
lib/oci8/metadata.rb,
ext/oci8/metadata.c

Overview

OCI8 has methods to obtain information about database objects such as tables, views, procedures, functions ans so on. The obtained data are called metadata and retrived as an instance of OCI8::Metadata::Base’s subclass.

List of methods which return OCI8::Metadata::Base.

  • OCI8#describe_any(object_name)

  • OCI8#describe_table(table_name, table_only = false)

  • OCI8#describe_view(view_name)

  • OCI8#describe_procedure(procedure_name)

  • OCI8#describe_function(function_name)

  • OCI8#describe_package(package_name)

  • OCI8#describe_type(type_name)

  • OCI8#describe_synonym(synonym_name, check_public_also = true)

  • OCI8#describe_sequence(sequence_name)

  • OCI8#describe_schema(schema_name)

  • OCI8#describe_database(database_name)

  • OCI8::Metadata::Type#map_method

  • OCI8::Metadata::Type#order_method

  • OCI8::Metadata::Type#collection_element

List of methods which return an array of OCI8::Metadata::Base.

  • OCI8::Cursor#column_metadata

  • OCI8::Metadata::Database#schemas

  • OCI8::Metadata::Schema#all_objects

  • OCI8::Metadata::Schema#objects

  • OCI8::Metadata::Table#columns

  • OCI8::Metadata::Package#subprograms

  • OCI8::Metadata::Procedure#arguments

  • OCI8::Metadata::Function#arguments

  • OCI8::Metadata::Type#type_attrs

  • OCI8::Metadata::Type#type_methods

  • OCI8::Metadata::TypeMethod#arguments

Example:

conn = OCI8.new('username/passord')
table = conn.describe_table('scott.emp')
table.columns.each do |col|
  puts "#{col.name} #{col.data_type_string}"
end

Defined Under Namespace

Classes: ArgBase, Argument, Base, Collection, Column, Database, Function, List, Package, Procedure, Schema, Sequence, Subprogram, Synonym, Table, Type, TypeArgument, TypeAttr, TypeMethod, TypeResult, Unknown, View