Difference between revisions of "Esmith::DomainsDB"

From SME Server
Jump to navigationJump to search
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
=== NAME ===
 
=== NAME ===
esmith::DomainsDB - interface to esmith domains database
+
esmith::DomainsDB - interface to esmith domains database
 
In a root terminal you can do the command below if you want to display the up-to-date content  
 
In a root terminal you can do the command below if you want to display the up-to-date content  
 
  perldoc -U esmith::DomainsDB
 
  perldoc -U esmith::DomainsDB
Line 22: Line 22:
  
 
Like esmith::DB->open_ro, but if given no $file it will try to open the file in the ESMITH_DOMAINS_DB environment variable or domains.
 
Like esmith::DB->open_ro, but if given no $file it will try to open the file in the ESMITH_DOMAINS_DB environment variable or domains.
 +
 +
===Example===
 +
Retrieve the list of all domains in an array
 +
 +
use esmith::DomainsDB;
 +
 +
my $d = esmith::DomainsDB->open_ro();
 +
my @domains = $d->keys();
  
 
=== AUTHOR ===
 
=== AUTHOR ===

Latest revision as of 10:30, 12 August 2016

NAME

esmith::DomainsDB - interface to esmith domains database

In a root terminal you can do the command below if you want to display the up-to-date content

perldoc -U esmith::DomainsDB

SYNOPSIS

use esmith::DomainsDB;

          my $c = esmith::DomainsDB->open;
  1. everything else works just like esmith::DB::db

DESCRIPTION

This module provides an abstracted interface to the esmith domain database.

Unless otherwise noted, esmith::DomainsDB acts like esmith::DB::db.

open()

Like esmith::DB->open, but if given no $file it will try to open the file in the ESMITH_DOMAINS_DB environment variable or domains.

open_ro()

Like esmith::DB->open_ro, but if given no $file it will try to open the file in the ESMITH_DOMAINS_DB environment variable or domains.

Example

Retrieve the list of all domains in an array

use esmith::DomainsDB;

my $d = esmith::DomainsDB->open_ro();
my @domains = $d->keys();

AUTHOR

      SME Server Developers <bugs@e-smith.com>