Rose::DB::Object::Metadata::Column::Bitfield(3pm)

NAME

Rose::DB::Object::Metadata::Column::Bitfield - Bitfield column metadata.

SYNOPSIS

  use Rose::DB::Object::Metadata::Column::Bitfield;
  $col = Rose::DB::Object::Metadata::Column::Bitfield->new(...);
  $col->make_methods(...);
  ...

DESCRIPTION

Objects of this class store and manipulate metadata for bitfield columns in a database. Column metadata objects store information about columns (data type, size, etc.) and are responsible for parsing, formatting, and creating object methods that manipulate column values.

This class inherits from Rose::DB::Object::Metadata::Column. Inherited methods that are not overridden will not be documented a second time here. See the Rose::DB::Object::Metadata::Column documentation for more information.

Important note: if you are using MySQL 5.0.3 or later, you must allow inline column values in any Rose::DB::Object-derived class that has one or more bitfield columns. (That is, columns that use the "BIT" data type.) This requirement may be relaxed in the future.

METHOD MAP

"get_set": Rose::DB::Object::MakeMethods::Generic, bitfield, ...

"get": Rose::DB::Object::MakeMethods::Generic, bitfield, ...

"get_set": Rose::DB::Object::MakeMethods::Generic, bitfield, ...

See the Rose::DB::Object::Metadata::Column documentation for an explanation of this method map.

OBJECT METHODS

bits [INT]: Get or set the number of bits in the column.

parse_value DB, VALUE: Convert VALUE to the equivalent "Bit::Vector" object. The return value of the column object's "bits()" method is used to determine the length of the bitfield in bits. DB is a Rose::DB object that is used as part of the parsing process. Both arguments are required.

type: Returns "bitfield".

AUTHOR

John C. Siracusa ([email protected])