---
name: "Rose::DB::Object::Metadata::Column::Scalar"
section: "3pm"
platform: "linux"
package: "librose-db-object-perl"
version: "1:0.820-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Rose::DB::Object::Metadata::Column::Scalar"
---

# Rose::DB::Object::Metadata::Column::Scalar(3pm)

Scalar column metadata.

## NAME

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

## SYNOPSIS

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

## DESCRIPTION

Objects of this class store and manipulate metadata for scalar columns in a database.  Column metadata objects store information about columns (data type, size, etc.) and are responsible for 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.

## METHOD MAP

- "get\_set"

  Rose::DB::Object::MakeMethods::Generic, scalar, `"interface => 'get_set', ..."`

- "get"

  Rose::DB::Object::MakeMethods::Generic, scalar, `"interface => 'get', ..."`

- "get\_set"

  Rose::DB::Object::MakeMethods::Generic, scalar, `"interface => 'set', ..."`

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

## OBJECT METHODS

- **check\_in \[ARRAYREF\]**

  Get or set a reference to an array of valid column values.

- **default VALUE**

  Get or set the default value for the column.

- **init\_method \[NAME\]**

  Get or set the name of the "init" method.  See the documentation for the `"scalar"` method type in Rose::DB::Object::MakeMethods::Generic for more information.

- **length \[INT\]**

  Get or set the length of the column in characters.

- **overflow \[BEHAVIOR\]**

  Get or set the setting that determines the behavior when the column value is greater than length characters.  Valid values for BEHAVIOR are:

  - **fatal**

    Throw an exception.

  - **truncate**

    Truncate the column value to the correct length.

  - **warn**

    Print a warning message.

  The default value is "fatal".

- **type**

  Returns "scalar".

- **with\_init \[BOOL\]**

  Get or set the flag that determines whether or not the method created by `"make_method()"` will include an "init" method as well.  See the documentation for the scalar method type in Rose::DB::Object::MakeMethods::Generic for more information.

## AUTHOR

John C. Siracusa (siracusa@gmail.com)

## LICENSE

Copyright (c) 2010 by John C. Siracusa.  All rights reserved.  This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.