Couch-DB

 view release on metacpan or  search on metacpan

ChangeLog  view on Meta::CPAN

version 0.002: Fri 31 May 10:27:47 CEST 2024

	Fixes:
	- include Couch::DB::Design
	- metacpan HTML of calls.

	Improvements:
	- implemented pagination with $result->nextPage (untested)
	- many documentation fixes
	- make cross-reference page available.
	- add cross-reference table Couch::DB -> endpoint

version 0.001: Wed 29 May 18:19:12 CEST 2024

	- initial release, interface complete but mainly untested.

bin/reference-table  view on Meta::CPAN

	foreach my $tr ($tree->elementify->find('table')->find('tr'))
	{	my (undef, $which, $what) = $tr->find('td');
		my ($a)  = $which->find('a') or next;
		my $href = $a->attr('href');
		my $call = $a->find_by_attribute(class => 'xref')->content->[0];

		# Mistake in 3.3.3 docs
		$call    = 'POST /{db}/_design/{ddoc}/_update/{func}/{docid}'
			if $call eq 'PUT /{db}/_design/{ddoc}/_update/{func}/{docid}';

		my ($http_method, $endpoint) = split " ", $call, 2;
		my $descr = $what->as_text;
	
		my %def    = (
			call        => $call,
			http_method => $http_method,
			endpoint    => $endpoint,
			doclink     => "$couchdb_api/$href",
			descr       => $descr,
		);
		$index{$call} = \%def;
	}

	# These are only described in notes in 3.3.3
	foreach my $endpoint ('/{db}/_local_docs/queries', '/{db}/_design_docs/queries')
	{	my %def = %{$index{'POST /{db}/_all_docs/queries'}};
		$def{call}     = "POST $endpoint";
		$def{endpoint} = $endpoint;
		$def{descr}    = '';
		$index{"POST $endpoint"} = \%def;
	}

	warn "Found ", scalar keys %index, " calls in the API docs\n";

}

####
###### parse the docs from implementation
####

reference.html  view on Meta::CPAN

  <tr><td>UNTESTED</td>
      <td class="count">77</td>
      <td>Implemented but never tried.</td></tr>
  <tr><td>TODO</td>
      <td class="count">2</td>
      <td>Implementation not started.</td></tr>
  <tr><td>UNSUPPORTED</td>
      <td class="count">5</td>
      <td>For some reason, it seems useless to implement this.</td></tr>
  </table>
  <h2 name="cdb2mod">CouchDB endpoint &rarr; Couch::DB method</h2>
  <ul>
  <li><a href="#mod2cdb">Couch::DB method &rarr; CouchDB endpoint</a></li>
  </ul>

  <table id="cdb2mod">
  <tr><th style="width: 50%"><a href="https://docs.couchdb.org/en/stable/">CouchDB API "stable"</a> and official summary</th>
      <th>impl status</th>
      <th>Couch::DB use</th></tr>

  <tr class="first">
      <td class="api"><a href="https://docs.couchdb.org/en/stable/api/server/common.html#get--">GET /</a></td>
      <td class="status">DONE</td>

 view all matches for this distribution
 view release on metacpan -  search on metacpan