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).



1625
1626
1627
 
# File 'lib/oci8/metadata.rb', line 1625

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



1613
1614
1615
 
# File 'lib/oci8/metadata.rb', line 1613

def charset_form
  __charset_form
end

#charset_id ⇒ Object

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



1607
1608
1609
 
# File 'lib/oci8/metadata.rb', line 1607

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



1619
1620
1621
 
# File 'lib/oci8/metadata.rb', line 1619

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.



1501
1502
1503
 
# File 'lib/oci8/metadata.rb', line 1501

def data_size
  attr_get_ub2(OCI_ATTR_DATA_SIZE)
end

#data_type ⇒ Object

the datatype of the argument



1494
1495
1496
 
# File 'lib/oci8/metadata.rb', line 1494

def data_type
  __data_type
end

#has_default ⇒ 1 or 0

Deprecated.

Indicates whether an argument has a default

Returns:

  • (1 or 0) 


1530
1531
1532
 
# File 'lib/oci8/metadata.rb', line 1530

def has_default
  attr_get_ub1(OCI_ATTR_HAS_DEFAULT)
end

#has_default? ⇒ true or false

Indicates whether an argument has a default

Returns:

  • (true or false)

Since:

  • 2.1.6



1538
1539
1540
 
# File 'lib/oci8/metadata.rb', line 1538

def has_default?
  __boolean(OCI_ATTR_HAS_DEFAULT)
end

#inspect ⇒ Object

:nodoc:



1629
1630
1631
 
# File 'lib/oci8/metadata.rb', line 1629

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

#iomode ⇒ Object

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



1551
1552
1553
1554
1555
1556
1557
 
# File 'lib/oci8/metadata.rb', line 1551

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.



1522
1523
1524
 
# File 'lib/oci8/metadata.rb', line 1522

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.



1596
1597
1598
 
# File 'lib/oci8/metadata.rb', line 1596

def link
  attr_get_string(OCI_ATTR_LINK)
end

#name ⇒ Object

the argument name



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

def name
  attr_get_string(OCI_ATTR_NAME)
end

#position ⇒ Object

the position of the argument in the argument list.



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

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.



1509
1510
1511
 
# File 'lib/oci8/metadata.rb', line 1509

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)



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

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.



1517
1518
1519
 
# File 'lib/oci8/metadata.rb', line 1517

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



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

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



1588
1589
1590
 
# File 'lib/oci8/metadata.rb', line 1588

def sub_name
  attr_get_string(OCI_ATTR_SUB_NAME)
end

#type_metadata ⇒ Object

to type metadata if possible



1601
1602
1603
 
# File 'lib/oci8/metadata.rb', line 1601

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.



1575
1576
1577
 
# File 'lib/oci8/metadata.rb', line 1575

def type_name
  attr_get_string(OCI_ATTR_TYPE_NAME)
end

#typecode ⇒ Object

typecode



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

def typecode
  __typecode(OCI_ATTR_TYPECODE)
end