Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MySQL::Diff::Table(3) User Contributed Perl DocumentationMySQL::Diff::Table(3)

NAME
       MySQL::Diff::Table - Table Definition Class

SYNOPSIS
	 use MySQL::Diff::Table

	 my $db	= MySQL::Diff::Database->new(%options);
	 my $def	   = $db->def();
	 my $name	   = $db->name();
	 my $field	   = $db->field();
	 my $fields	   = $db->fields();		   # %$fields
	 my $primary_key   = $db->primary_key();
	 my $indices	   = $db->indices();		   # %$indices
	 my $options	   = $db->options();

	 my $isfield	   = $db->isa_field($field);
	 my $isprimary	   = $db->isa_primary($field);
	 my $isindex	   = $db->isa_index($field);
	 my $isunique	   = $db->is_unique($field);
	 my $isfulltext	   = $db->is_fulltext($field);

DESCRIPTION
       Parses a	table definition into component	parts.

METHODS
   Constructor
       new( %options )
	   Instantiate the objects, providing the command line options for
	   database access and process requirements.

   Public Methods
       Fuller documentation will appear	here in	time :)

       o   def

	   Returns the table definition	as a string.

       o   name

	   Returns the name of the current table.

       o   field

	   Returns the current field definition	of the given field.

       o   fields

	   Returns an array reference to a list	of fields.

       o   primary_key

	   Returns a hash reference to fields used as primary key fields.

       o   indices

	   Returns a hash reference to fields used as index fields.

       o   options

	   Returns the additional options added	to the table definition.

       o   isa_field

	   Returns 1 if	given field is used in the current table definition,
	   otherwise returns 0.

       o   isa_primary

	   Returns 1 if	given field is defined as a primary key, otherwise
	   returns 0.

       o   isa_index

	   Returns 1 if	given field is used as an index	field, otherwise
	   returns 0.

       o   is_unique

	   Returns 1 if	given field is used as unique index field, otherwise
	   returns 0.

       o   is_fulltext

	   Returns 1 if	given field is used as fulltext	index field, otherwise
	   returns 0.

       o   is_auto_inc

	   Returns 1 if	given field is defined as an auto increment field,
	   otherwise returns 0.

COPYRIGHT AND LICENSE
       Copyright (c) 2000-2016 Adam Spiers. All	rights reserved. This program
       is free software; you can redistribute it and/or	modify it under	the
       same terms as Perl itself.

SEE ALSO
       mysqldiff, MySQL::Diff, MySQL::Diff::Database, MySQL::Diff::Utils

AUTHOR
       Adam Spiers <mysqldiff@adamspiers.org>

perl v5.24.1			  2016-07-21		 MySQL::Diff::Table(3)

NAME | SYNOPSIS | DESCRIPTION | METHODS | COPYRIGHT AND LICENSE | SEE ALSO | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=MySQL::Diff::Table&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help