Class: OCI8::Metadata::ArgBase

Inherits:
Base
  • Object
show all
Defined in:
lib/oci8/metadata.rb

Overview

Abstract super class of Argument, TypeArgument and TypeResult.

Direct Known Subclasses

Argument, TypeArgument, TypeResult

Instance Method Summary collapse

Methods inherited from Base

#obj_id, #obj_name, #obj_schema

Instance Method Details

#arguments ⇒ Object

The list of arguments at the next level (when the argument is of a record or table type).



1577
1578
1579
 
# File 'lib/oci8/metadata.rb', line 1577

def arguments
  @arguments ||= list_arguments.to_a
end

#charset_form ⇒ Object

Returns the character set form if the argument is of a string/character type



1565
1566
1567
 
# File 'lib/oci8/metadata.rb', line 1565

def charset_form
  __charset_form
end

#charset_id ⇒ Object

Returns the character set ID if the argument is of a string/character type



1559
1560
1561
 
# File 'lib/oci8/metadata.rb', line 1559

def charset_id
  attr_get_ub2(OCI_ATTR_CHARSET_ID)
end

#charset_name ⇒ Object

Returns the character set name if the argument is of a string/character type



1571
1572
1573
 
# File 'lib/oci8/metadata.rb', line 1571

def charset_name
  __charset_name(charset_id)
end

#data_size ⇒ Object

The size of the datatype of the argument. This length is returned in bytes and not characters for strings and raws. It returns 22 for NUMBERs.



1464
1465
1466
 
# File 'lib/oci8/metadata.rb', line 1464

def data_size
  attr_get_ub2(OCI_ATTR_DATA_SIZE)
end

#data_type ⇒ Object

the datatype of the argument



1457
1458
1459
 
# File 'lib/oci8/metadata.rb', line 1457

def data_type
  __data_type
end

#has_default ⇒ Object

Indicates whether an argument has a default



1490
1491
1492
 
# File 'lib/oci8/metadata.rb', line 1490

def has_default
  attr_get_ub1(OCI_ATTR_HAS_DEFAULT)
end

#inspect ⇒ Object

:nodoc:



1581
1582
1583
 
# File 'lib/oci8/metadata.rb', line 1581

def inspect # :nodoc:
  "#<#{self.class.name}: #{name} #{__data_type_string}>"
end

#iomode ⇒ Object

Indicates the argument mode. Values are :in, :out or :inout



1503
1504
1505
1506
1507
1508
1509
 
# File 'lib/oci8/metadata.rb', line 1503

def iomode
  case attr_get_ub4(OCI_ATTR_IOMODE)
  when 0; :in
  when 1; :out
  when 2; :inout
  end
end

#level ⇒ Object

The datatype levels. This attribute always returns zero.



1485
1486
1487
 
# File 'lib/oci8/metadata.rb', line 1485

def level
  attr_get_ub2(OCI_ATTR_LEVEL)
end

#link ⇒ Object

For :named_type or :ref, returns a string with the database link name of the database on which the type exists. This can happen only in the case of package local types, when the package is remote.



1548
1549
1550
 
# File 'lib/oci8/metadata.rb', line 1548

def link
  attr_get_string(OCI_ATTR_LINK)
end

#name ⇒ Object

the argument name



1442
1443
1444
 
# File 'lib/oci8/metadata.rb', line 1442

def name
  attr_get_string(OCI_ATTR_NAME)
end

#position ⇒ Object

the position of the argument in the argument list.



1447
1448
1449
 
# File 'lib/oci8/metadata.rb', line 1447

def position
  attr_get_ub2(OCI_ATTR_POSITION)
end

#precision ⇒ Object

The precision of numeric arguments. If the precision is nonzero and scale is -127, then it is a FLOAT, else it is a NUMBER(precision, scale). For the case when precision is 0, NUMBER(precision, scale) can be represented simply as NUMBER.



1472
1473
1474
 
# File 'lib/oci8/metadata.rb', line 1472

def precision
  __is_implicit? ? attr_get_sb2(OCI_ATTR_PRECISION) : attr_get_ub1(OCI_ATTR_PRECISION)
end

#radix ⇒ Object

Returns a radix (if number type)



1512
1513
1514
 
# File 'lib/oci8/metadata.rb', line 1512

def radix
  attr_get_ub1(OCI_ATTR_RADIX)
end

#scale ⇒ Object

The scale of numeric arguments. If the precision is nonzero and scale is -127, then it is a FLOAT, else it is a NUMBER(precision, scale). For the case when precision is 0, NUMBER(precision, scale) can be represented simply as NUMBER.



1480
1481
1482
 
# File 'lib/oci8/metadata.rb', line 1480

def scale
  attr_get_sb1(OCI_ATTR_SCALE)
end

#schema_name ⇒ Object

For :named_type or :ref, returns a string with the schema name under which the type was created, or under which the package was created in the case of package local types



1534
1535
1536
 
# File 'lib/oci8/metadata.rb', line 1534

def schema_name
  attr_get_string(OCI_ATTR_SCHEMA_NAME)
end

#sub_name ⇒ Object

For :named_type or :ref, returns a string with the type name, in the case of package local types



1540
1541
1542
 
# File 'lib/oci8/metadata.rb', line 1540

def sub_name
  attr_get_string(OCI_ATTR_SUB_NAME)
end

#type_metadata ⇒ Object

to type metadata if possible



1553
1554
1555
 
# File 'lib/oci8/metadata.rb', line 1553

def type_metadata
  __type_metadata(OCI8::Metadata::Type)
end

#type_name ⇒ Object

Returns a string which is the type name, or the package name in the case of package local types. The returned value will contain the type name if the datatype is :named_type or :ref. If the datatype is :named_type, the name of the named datatype’s type is returned. If the datatype is :ref, the type name of the named datatype pointed to by the REF is returned.



1527
1528
1529
 
# File 'lib/oci8/metadata.rb', line 1527

def type_name
  attr_get_string(OCI_ATTR_TYPE_NAME)
end

#typecode ⇒ Object

typecode



1452
1453
1454
 
# File 'lib/oci8/metadata.rb', line 1452

def typecode
  __typecode(OCI_ATTR_TYPECODE)
end