view release on metacpan or  search on metacpan

lib/Bigtop/Docs/FullKeywords.pod  view on Meta::CPAN

=head2 extra_sql

=over 4

=item sql

Literal SQL, use bind parameters, see below.


This statement is required.

=item expects

What your SQL needs for positional binding.  [optional, omit if you have no bound parameters]


Values for expects statements may be individual values
or pairs like:

    name => optional_value

where C<name> is a name and C<optional_value> is a type.

You may supply a comma separated list of values for
expects statements.

This statement is virtually required.

=item returns

Names of columns in SQL output.  [optional, omit if you expect no returned rows]


Values for returns statements may be individual values
or pairs like:

    name => optional_value

where C<name> is a name and C<optional_value> is a type.

You may supply a comma separated list of values for
returns statements.

This statement is virtually required.

=back

=head2 field

=over 4

=item no_gen

Skip this field completely


This field is boolean, use 1 for true or 0 for false.


=item not_for

Tell Model and/or SQL to skip this field


Only certain values are legal for statement.keyword statements.
Please choose from these options:

=over 4

=item SQL

SQL

=item Model

Model


=back

You may supply a comma separated list of values for
not_for statements.

=item is

SQL type clause phrases, e.g.:

    int4
    varchar
    primary_key
    auto



You may supply a comma separated list of values for
is statements.

This statement is required.

=item accessor

DBIx::Class alternate accessor name for this column


You may supply a comma separated list of values for
accessor statements.

=item add_columns

DBIx::Class alternate column addition


All values for add_columns statements must be pairs like:

    name => its_value

where C<name> is a key and C<its_value> is a value.

You may supply a comma separated list of values for
add_columns statements.

=item refers_to

Where this foreign key points


Values for refers_to statements may be individual values
or pairs like:

    name => optional_value

where C<name> is a table and C<optional_value> is a column.

This statement is only occasionally used.

=item quasi_refers_to

Where this column usually points


Values for quasi_refers_to statements may be individual values
or pairs like:

lib/Bigtop/Docs/FullKeywords.pod  view on Meta::CPAN

=item form_name

Form name [used with date selections]

Applies to methods of type: AutoCRUD_form and CRUD_form.


=item expects

Things your SOAP method receives

Applies to methods of type: SOAP and SOAPDoc.


Values for expects statements may be individual values
or pairs like:

    name => optional_value

where C<name> is a name and C<optional_value> is a type.

You may supply a comma separated list of values for
expects statements.

This statement is required.

=item returns

Things your SOAP method returns

Applies to methods of type: SOAP and SOAPDoc.


Values for returns statements may be individual values
or pairs like:

    name => optional_value

where C<name> is a name and C<optional_value> is a type.

You may supply a comma separated list of values for
returns statements.

This statement is required.

=back

=head2 table

=over 4

=item no_gen

Skip this table completely


This field is boolean, use 1 for true or 0 for false.


=item not_for

Tell Model and/or SQL to skip this table


Only certain values are legal for statement.keyword statements.
Please choose from these options:

=over 4

=item SQL

SQL

=item Model

Model


=back

You may supply a comma separated list of values for
not_for statements.

=item foreign_display

Pattern string for other tables: %last, %first


This statement is frequently used.

=item refered_to_by

Table has many rows from this other table


Values for refered_to_by statements may be individual values
or pairs like:

    name => optional_value

where C<name> is a foreign table and C<optional_value> is a name of has many.

You may supply a comma separated list of values for
refered_to_by statements.

=item model_base_class

Models inherit from this [has good default]


=item sequence

Which sequence to take default keys from


This statement is only occasionally used.

=item label

Documentation label for table


=item data

What to INSERT INTO table upon initial creation


Values for data statements may be individual values
or pairs like:

    name => optional_value


You may supply a comma separated list of values for
data statements.

You may use multiple data statements.

=back

=head1 AUTHOR