/ 
FTN-Database-0.15
River stage one • 2 direct dependents • 2 total dependents
/ FTN::Database::Nodelist

NAME

FTN::Database::Nodelist - Fidonet/FTN Nodelist SQL Database operations.

VERSION

Version 0.15

DESCRIPTION

FTN::Database::Nodelist is a Perl module containing common nodelist related subroutines for Fidonet/FTN Nodelist related processing on a Nodelist table in an SQL Database. The SQL database engine is one for which a DBD module exists, defaulting to SQLite.

EXPORT

The following functions are available in this module: create_nodelist_table(), drop_nodelist_table(), create_ftnnode_index(), remove_ftn_domain().

FUNCTIONS

create_nodelist_table

Syntax: create_nodelist_table($db_handle, $table_name);

Create an FTN Nodelist table in an SQL database being used for Fidonet/FTN processing, where $db_handle is an existing open database handle and $table_name is the name of the table to be created.

drop_nodelist_table

Syntax: drop_nodelist_table($db_handle, $table_name);

Drop an FTN Nodelist table from an SQL database being used for Fidonet/FTN processing if it exists, where $db_handle is an existing open database handle and $table_name is the name of the table to be dropped.

create_ftnnode_index

Syntax: create_ftnnode_index($db_handle, $table_name);

Create an index named ftnnode on an FTN Nodelist table in an SQL database being used for Fidonet/FTN processing, where $db_handle is an existing open database handle and $table_name is the name of the table that is being indexed. The index is created on the following fields: zone, net, node, point, and domain.

drop_ftnnode_index

Syntax: drop_ftnnode_index($db_handle);

Drop an index named ftnnode on an FTN Nodelist table in an SQL database being used for Fidonet/FTN processing if it exists, where $db_handle is an existing open database handle.

remove_ftn_domain

Syntax: remove_ftn_domain($db_handle, $table_name, $domain);

Remove all entries for a particular FTN domain from an FTN nodelist table in an SQL database being used for FTN processing; where $db_handle is an existing open database handle and $table_name is the name of the table from which the FTN domain $domain is being removed.

EXAMPLES

An example of opening an FTN database, then creating a nodelist table, loading data to it, then creating an index on it, and the closing the database:

use FTN::Database::Nodelist;

my $db_handle = open_ftndb($db_type, $db_name, $db_user, $db_pass);
create_nodelist_table($db_handle, $table_name);
...   (Load data to nodelist table)
create_ftnnode_index($db_handle, $table_name);
close_ftndb($db_handle);

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 FTN::Database::Nodelist

You can also look for information at:

SEE ALSO

L<FTN::Database>, L<ftndbadm>, L<listftndb>, L<ftndbadm>,
and L<nl2ftndb>

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.