/ 
FTN-Database-0.17
River stage one • 2 direct dependents • 2 total dependents
/ ftnpldb-admin

NAME

ftnpldb-admin - Administration of an SQL database for Fidonet/FTN processing.

VERSION

Version 0.17

DESCRIPTION

Administration of a database for Fidonet/FTN related processing. The SQL database engine is one for which a DBD module exists, defaulting to SQLite.

SYNOPSIS

ftnpldb-admin -c config_file [options] [-d databasename] create|drop database

ftnpldb-admin -c config_file [options] [-t tablename] create|drop table

ftnpldb-admin [-h | --help]

ftnpldb-admin --version

OPTIONS

-c

This is the filename and path of a configuration file, with the default being ftnpldb.cfg in the current directory.

-l

This would be the filename and path of a log file, with the default being ftnpldb.log in the current directory.

-x

Debug option.

-v

Verbose option.

-d

Name of the database being created or dropped.

-t

The nodelist table name to be used. Note that if there is a period in the name, that period will be changed to an underscore.

COMMANDS

create database

This will create a database an SQL database server being used for Fidonet/FTN processing. If it already exists, it will drop it first, before going on to create it again.

drop database

This will drop a database if it exists in an SQL database server being used for Fidonet/FTN processing.

create table

This will create a nodelist table in an SQL database being used for Fidonet/FTN nodelist processing. If it already exists, it will drop it first before going on to create it again.

drop table

This will drop a database table if it exists in an SQL database server being used for Fidonet/FTN processing.

CONFIGURATION

The Database section in the configuration file has the following keywords:

Type

Database type. This needs to be a database type for which a DBD module exists, the type being the name as used in the DBD module. The default type is SQLite.

Name

Database name. For an SQLite database; this needs to be at least the filename and can also include a path.

User

Database user. For an SQLite database, this defaults to an empty string as it is not needed for that type of a database.

Password

Database password. For an SQLite database, this defaults to an empty string as it is not needed for that type of a database.

This is an example of the contents of an ftnpldb.cfg file:

[Database]
Type=mysql
Name=ftndbtst
User=sysop
Password=ftndbtst

EXAMPLES

Given that $CFGFILE is a configuration file, the following command line can be used to create an FTN Nodelist table in that database file:

ftnpldb-admin -c $CFGFILE -t Nodelist -v create table

AUTHOR

Robert James Clay, <jame at rocasa.us>

BUGS

Please report any bugs or feature requests to bug-ftn-database at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=FTN-Database. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc ftnpldb-admin

You can also look for information at:

SEE ALSO

L<FTN::Database>, L<FTN::Database::Nodelist>, and L<ftnpldb-nodelist>.

COPYRIGHT & LICENSE

Copyright 2010 Robert James Clay, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.