Class: OCI8::Metadata::Column

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

Overview

Metadata for a sequence.

This is returned by:

  • OCI8::Metadata::Table#columns

Instance Method Summary collapse

Methods inherited from Base

#obj_id, #obj_name, #obj_schema

Instance Method Details

#char_size ⇒ Object

returns the column character length which is the number of characters allowed in the column. It is the counterpart of OCI8::Metadata::Column#data_size which gets the byte length.



1317
1318
1319
 
# File 'lib/oci8/metadata.rb', line 1317

def char_size
  attr_get_ub2(OCI_ATTR_CHAR_SIZE)
end

#char_used? ⇒ Boolean

returns the type of length semantics of the column.

:byte

byte-length semantics

:char

character-length semantics.

(unavailable on Oracle 8.1 or lower)

Returns:

  • (Boolean) 


1310
1311
1312
 
# File 'lib/oci8/metadata.rb', line 1310

def char_used?
  attr_get_ub1(OCI_ATTR_CHAR_USED) != 0
end

#charset_form ⇒ Object

The character set form, if the column is of a string/character type



1403
1404
1405
 
# File 'lib/oci8/metadata.rb', line 1403

def charset_form
  __charset_form
end

#charset_id ⇒ Object

The character set id, if the column is of a string/character type



1398
1399
1400
 
# File 'lib/oci8/metadata.rb', line 1398

def charset_id
  attr_get_ub2(OCI_ATTR_CHARSET_ID)
end

#charset_name ⇒ Object

The character set name, if the column is of a string/character type



1427
1428
1429
 
# File 'lib/oci8/metadata.rb', line 1427

def charset_name
  __charset_name(charset_id)
end

#data_size ⇒ Object

The maximum size of the column. This length is returned in bytes and not characters for strings and raws. This returns character length multiplied by NLS ratio for character-length semantics columns when using Oracle 9i or upper.



1335
1336
1337
 
# File 'lib/oci8/metadata.rb', line 1335

def data_size
  attr_get_ub2(OCI_ATTR_DATA_SIZE)
end

#data_type ⇒ Object

the datatype of the column.



1340
1341
1342
 
# File 'lib/oci8/metadata.rb', line 1340

def data_type
  __data_type
end

#data_type_string ⇒ Object Also known as: type_string 



1431
1432
1433
 
# File 'lib/oci8/metadata.rb', line 1431

def data_type_string
  __data_type_string
end

#fsprecision ⇒ Object

The fractional seconds precision of a datetime or interval.

(unavailable on Oracle 8.1 or lower)



1414
1415
1416
 
# File 'lib/oci8/metadata.rb', line 1414

def fsprecision
  attr_get_ub1(OCI_ATTR_FSPRECISION)
end

#inspect ⇒ Object

:nodoc:



1440
1441
1442
 
# File 'lib/oci8/metadata.rb', line 1440

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

#lfprecision ⇒ Object

The leading field precision of an interval

(unavailable on Oracle 8.1 or lower)



1421
1422
1423
 
# File 'lib/oci8/metadata.rb', line 1421

def lfprecision
  attr_get_ub1(OCI_ATTR_LFPRECISION)
end

#name ⇒ Object

column name



1345
1346
1347
 
# File 'lib/oci8/metadata.rb', line 1345

def name
  attr_get_string(OCI_ATTR_NAME)
end

#nullable? ⇒ Boolean

Returns 0 if null values are not permitted for the column

Returns:

  • (Boolean) 


1366
1367
1368
 
# File 'lib/oci8/metadata.rb', line 1366

def nullable?
  __boolean(OCI_ATTR_IS_NULL)
end

#precision ⇒ Object

The precision of numeric columns. 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.



1353
1354
1355
 
# File 'lib/oci8/metadata.rb', line 1353

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

#scale ⇒ Object

The scale of numeric columns. 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.



1361
1362
1363
 
# File 'lib/oci8/metadata.rb', line 1361

def scale
  attr_get_sb1(OCI_ATTR_SCALE)
end

#schema_name ⇒ Object

Returns a string with the schema name under which the type has been created



1382
1383
1384
1385
 
# File 'lib/oci8/metadata.rb', line 1382

def schema_name
  rv = attr_get_string(OCI_ATTR_SCHEMA_NAME)
  rv.length == 0 ? nil : rv
end

#to_s ⇒ Object 



1436
1437
1438
 
# File 'lib/oci8/metadata.rb', line 1436

def to_s
  %Q{"#{name}" #{__data_type_string}}
end

#type_metadata ⇒ Object

to type metadata if possible



1388
1389
1390
1391
1392
1393
1394
1395
 
# File 'lib/oci8/metadata.rb', line 1388

def type_metadata
  case attr_get_ub2(OCI_ATTR_DATA_TYPE)
  when 108, 110 # named_type or ref
    __type_metadata(OCI8::Metadata::Type)
  else
    nil
  end
end

#type_name ⇒ Object

Returns a string which is the type name. 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



1376
1377
1378
1379
 
# File 'lib/oci8/metadata.rb', line 1376

def type_name
  rv = attr_get_string(OCI_ATTR_TYPE_NAME)
  rv.length == 0 ? nil : rv
end