Class: OCI8::Metadata::ArgBase
Overview
Abstract super class of Argument, TypeArgument and TypeResult.
Direct Known Subclasses
Instance Method Summary collapse
-
#arguments ⇒ Object
The list of arguments at the next level (when the argument is of a record or table type).
-
#charset_form ⇒ Object
Returns the character set form if the argument is of a string/character type.
-
#charset_id ⇒ Object
Returns the character set ID if the argument is of a string/character type.
-
#charset_name ⇒ Object
Returns the character set name if the argument is of a string/character type.
-
#data_size ⇒ Object
The size of the datatype of the argument.
-
#data_type ⇒ Object
the datatype of the argument.
- #has_default ⇒ 1 or 0 deprecated Deprecated.
-
#has_default? ⇒ true or false
Indicates whether an argument has a default.
-
#inspect ⇒ Object
:nodoc:.
-
#iomode ⇒ Object
Indicates the argument mode.
-
#level ⇒ Object
The datatype levels.
-
#link ⇒ Object
For
:named_type
or:ref
, returns a string with the database link name of the database on which the type exists. -
#name ⇒ Object
the argument name.
-
#position ⇒ Object
the position of the argument in the argument list.
-
#precision ⇒ Object
The precision of numeric arguments.
-
#radix ⇒ Object
Returns a radix (if number type).
-
#scale ⇒ Object
The scale of numeric arguments.
-
#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. -
#sub_name ⇒ Object
For
:named_type
or:ref
, returns a string with the type name, in the case of package local types. -
#type_metadata ⇒ Object
to type metadata if possible.
-
#type_name ⇒ Object
Returns a string which is the type name, or the package name in the case of package local types.
-
#typecode ⇒ Object
typecode.
Methods inherited from Base
#obj_id, #obj_link, #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).
1634 1635 1636 |
# File 'lib/oci8/metadata.rb', line 1634 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
1622 1623 1624 |
# File 'lib/oci8/metadata.rb', line 1622 def charset_form __charset_form end |
#charset_id ⇒ Object
Returns the character set ID if the argument is of a string/character type
1616 1617 1618 |
# File 'lib/oci8/metadata.rb', line 1616 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
1628 1629 1630 |
# File 'lib/oci8/metadata.rb', line 1628 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.
1510 1511 1512 |
# File 'lib/oci8/metadata.rb', line 1510 def data_size attr_get_ub2(OCI_ATTR_DATA_SIZE) end |
#data_type ⇒ Object
the datatype of the argument
1503 1504 1505 |
# File 'lib/oci8/metadata.rb', line 1503 def data_type __data_type end |
#has_default ⇒ 1 or 0
Indicates whether an argument has a default
1539 1540 1541 |
# File 'lib/oci8/metadata.rb', line 1539 def has_default attr_get_ub1(OCI_ATTR_HAS_DEFAULT) end |
#has_default? ⇒ true or false
Indicates whether an argument has a default
1547 1548 1549 |
# File 'lib/oci8/metadata.rb', line 1547 def has_default? __boolean(OCI_ATTR_HAS_DEFAULT) end |
#inspect ⇒ Object
:nodoc:
1638 1639 1640 |
# File 'lib/oci8/metadata.rb', line 1638 def inspect # :nodoc: "#<#{self.class.name}: #{name} #{__data_type_string}>" end |
#iomode ⇒ Object
Indicates the argument mode. Values are :in
, :out
or :inout
1560 1561 1562 1563 1564 1565 1566 |
# File 'lib/oci8/metadata.rb', line 1560 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.
1531 1532 1533 |
# File 'lib/oci8/metadata.rb', line 1531 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.
1605 1606 1607 |
# File 'lib/oci8/metadata.rb', line 1605 def link attr_get_string(OCI_ATTR_LINK) end |
#name ⇒ Object
the argument name
1488 1489 1490 |
# File 'lib/oci8/metadata.rb', line 1488 def name attr_get_string(OCI_ATTR_NAME) end |
#position ⇒ Object
the position of the argument in the argument list.
1493 1494 1495 |
# File 'lib/oci8/metadata.rb', line 1493 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.
1518 1519 1520 |
# File 'lib/oci8/metadata.rb', line 1518 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)
1569 1570 1571 |
# File 'lib/oci8/metadata.rb', line 1569 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.
1526 1527 1528 |
# File 'lib/oci8/metadata.rb', line 1526 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
1591 1592 1593 |
# File 'lib/oci8/metadata.rb', line 1591 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
1597 1598 1599 |
# File 'lib/oci8/metadata.rb', line 1597 def sub_name attr_get_string(OCI_ATTR_SUB_NAME) end |
#type_metadata ⇒ Object
to type metadata if possible
1610 1611 1612 |
# File 'lib/oci8/metadata.rb', line 1610 def (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.
1584 1585 1586 |
# File 'lib/oci8/metadata.rb', line 1584 def type_name attr_get_string(OCI_ATTR_TYPE_NAME) end |
#typecode ⇒ Object
typecode
1498 1499 1500 |
# File 'lib/oci8/metadata.rb', line 1498 def typecode __typecode(OCI_ATTR_TYPECODE) end |