NAME

Couch::DB::Mojolicious - CouchDB backend for Mojolicious

INHERITANCE

Couch::DB::Mojolicious
  is a Couch::DB

SYNOPSIS

use Couch::DB::Mojolicious ();
my $couch = Couch::DB::Mojolicious->new;

# From here on: see the Couch::DB base class
my $db    = $couch->db('my-db');

DESCRIPTION

This is the Couch::DB implementation based on the Mojolicious (=Mojo) event framework. It uses many Mojo specific modules, like Mojo::URL and Mojo::UserAgent.

Extends "DESCRIPTION" in Couch::DB.

METHODS

Extends "METHODS" in Couch::DB.

Constructors

Extends "Constructors" in Couch::DB.

Couch::DB::Mojolicious->new(%options)

-Option  --Defined in     --Default
 api       Couch::DB        <required>
 auth      Couch::DB        'BASIC'
 password  Couch::DB        undef
 server    Couch::DB        "http://127.0.0.1:5984"
 to_json   Couch::DB        +{ }
 to_perl   Couch::DB        +{ }
 to_query  Couch::DB        +{ }
 username  Couch::DB        undef

api => $version

auth => 'BASIC'|'COOKIE'

password => STRING

server => URL

to_json => HASH

to_perl => HASH

to_query => HASH

username => STRING

Accessors

Extends "Accessors" in Couch::DB.

$obj->api()

Inherited, see "Accessors" in Couch::DB

Interface starting points

Extends "Interface starting points" in Couch::DB.

$obj->cluster()

Inherited, see "Interface starting points" in Couch::DB

$obj->createClient(%options)

Inherited, see "Interface starting points" in Couch::DB

$obj->db($name, %options)

Inherited, see "Interface starting points" in Couch::DB

$obj->node($name)

Inherited, see "Interface starting points" in Couch::DB

$obj->searchAnalyse(%options)

Inherited, see "Interface starting points" in Couch::DB

Server connections

The server is a Mojo::URL, or will be transformed into one. The user_agent is a Mojo::UserAgent.

Extends "Server connections" in Couch::DB.

$obj->addClient($client)

Inherited, see "Server connections" in Couch::DB

$obj->call(\%options|($method, $path, %options))

Inherited, see "Server connections" in Couch::DB

$obj->client($name)

Inherited, see "Server connections" in Couch::DB

$obj->clients(%options)

Inherited, see "Server connections" in Couch::DB

Conversions

Extends "Conversions" in Couch::DB.

$obj->check($condition, $change, $version, $what)

Inherited, see "Conversions" in Couch::DB

$obj->freshUUIDs($count, %options)

Inherited, see "Conversions" in Couch::DB

$obj->jsonText($json, %options)

Inherited, see "Conversions" in Couch::DB

$obj->listToPerl($set, $type, @data|\@data)

Inherited, see "Conversions" in Couch::DB

$obj->requestUUIDs($count, %options)

Inherited, see "Conversions" in Couch::DB

$obj->toJSON(\%data, $type, @keys)

Inherited, see "Conversions" in Couch::DB

$obj->toPerl(\%data, $type, @keys)

Inherited, see "Conversions" in Couch::DB

$obj->toQuery(\%data, $type, @keys)

Inherited, see "Conversions" in Couch::DB

Other

DETAILS

Extends "DETAILS" in Couch::DB.

SEE ALSO

This module is part of Couch-DB distribution version 0.002, built on May 31, 2024. Website: http://perl.overmeer.net/CPAN/

LICENSE

Copyrights 2024 by [Mark Overmeer]. For other contributors see ChangeLog.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See http://dev.perl.org/licenses/

cpanm Couch::DB

perl -MCPAN -e shell
install Couch::DB