Catmandu

Changes for version 1.2020 - 2023-02-08

Reordering documentation focussing on command line functionality
Adding Catmandu::PerAPI documentation
Updating Catmandu::Introduction
Supporting fix on an Catmandu::Iterable (obs nichtich)

Documentation

catmandu

LibreCat command line tools

Catmandu::Config

Configuration settings of Catmandu

Catmandu::Introduction

A 5 minute introduction to Catmandu

Catmandu::PerlAPI

A short overview of the current Catmandu Perl API

Modules

Catmandu

a data toolkit

Catmandu::Addable

Base class for all Catmandu modules need to implement add

Catmandu::ArrayIterator

Convert an arrayref to an Iterable object

Catmandu::Bag

A Catmandu::Store compartment to persist data

Catmandu::Bag::IdGenerator

A base role for bag identifier generators

Catmandu::Bag::IdGenerator::Mock

Generator of increasing identifiers for bags

Catmandu::Bag::IdGenerator::UUID

Generator of UUID identifiers for bags

Catmandu::Buffer

A base class for modules that need an array buffer

Catmandu::CLI

The App::Cmd application class for the catmandu command line script

Catmandu::CQLSearchable

Optional role for CQL searchable stores

Catmandu::Cmd

A base class for extending the Catmandu command line

Catmandu::Cmd::compile

compile a Fix into Perl (for debugging)

Catmandu::Cmd::config

export the Catmandu config

Catmandu::Cmd::convert

convert items

Catmandu::Cmd::copy

copy items from one store to another

Catmandu::Cmd::count

count the number of items in a bag

Catmandu::Cmd::delete

delete items from a store

Catmandu::Cmd::drop

drop a store or one of its bags

Catmandu::Cmd::export

export items from a store

Catmandu::Cmd::help

show help

Catmandu::Cmd::import

import items into a store

Catmandu::Cmd::info

list installed Catmandu modules

Catmandu::Cmd::run

run a fix command

Catmandu::Cmd::touch

add the current datetime to the items in a bag

Catmandu::Counter

A Base class for modules who need to count things

Catmandu::Droppable

Optional role for droppable stores or bags

Catmandu::Emit

Role with helper methods for code emitting

Catmandu::Env

A catmandu configuration file loader

Catmandu::Error

Catmandu error hierarchy

Catmandu::Exporter

Namespace for packages that can export

Catmandu::Exporter::CSV

a CSV exporter

Catmandu::Exporter::Count

a exporter that counts things

Catmandu::Exporter::JSON

a JSON exporter

Catmandu::Exporter::Mock

a exporter that doesn't export anything

Catmandu::Exporter::Multi

export you data to multiple exporters

Catmandu::Exporter::Null

a expoter that doesn't export anything

Catmandu::Exporter::TSV

a tab-delimited TSV exporter

Catmandu::Exporter::Text

a Text exporter

Catmandu::Exporter::YAML

a YAML exporter

Catmandu::Fix

a Catmandu class used for data transformations

Catmandu::Fix::Base

Base role for all code emitting Catmandu fixes

Catmandu::Fix::Bind

a wrapper for Catmandu::Fix-es

Catmandu::Fix::Bind::Group

a role for a binder that executes all fixes as one group

Catmandu::Fix::Bind::benchmark

a binder that calculates the execution time of Fix functions

Catmandu::Fix::Bind::each

a binder that executes fixes for every (key, value) pair in a hash

Catmandu::Fix::Bind::hashmap

a binder to add key/value pairs to an internal hashmap

Catmandu::Fix::Bind::identity

a binder that doesn't influence computation

Catmandu::Fix::Bind::importer

a binder runs fixes on records from an importer

Catmandu::Fix::Bind::iterate

a binder iterates fixes in a loop

Catmandu::Fix::Bind::list

a binder that computes Fix-es for every element in a list

Catmandu::Fix::Bind::maybe

a binder that skips fixes if one returns undef or dies

Catmandu::Fix::Bind::timeout

run fixes that should run within a time limit

Catmandu::Fix::Bind::visitor

a binder that computes Fix-es for every element in record

Catmandu::Fix::Bind::with

a binder that computes Fix-es in the context of a path

Catmandu::Fix::Builder

Base role for Catmandu fixes

Catmandu::Fix::Condition

Role for all Catmandu::Fix conditionals

Catmandu::Fix::Condition::Builder

Helper role to easily write fix conditions

Catmandu::Fix::Condition::Builder::Simple

Helper role to easily write fix conditions that test a value

Catmandu::Fix::Condition::SimpleAllTest

Base class to ease the construction of all match conditionals

Catmandu::Fix::Condition::SimpleAnyTest

Base class to ease the construction of any match conditionals

Catmandu::Fix::Condition::SimpleCompareTest

Base class to ease the construction of compare conditionals

Catmandu::Fix::Condition::all_equal

Execute fixes when all path values equal a string value

Catmandu::Fix::Condition::all_match

only execute fixes if all path values match the given regex

Catmandu::Fix::Condition::any_equal

Execute fixes when at least one of the path values equal a string value

Catmandu::Fix::Condition::any_match

only execute fixes if any path value matches the given regex

Catmandu::Fix::Condition::exists

only execute fixes if the path exists

Catmandu::Fix::Condition::greater_than

Execute fixes when a field is greater than a value

Catmandu::Fix::Condition::in

only execute fixes the data in one path is contained in another

Catmandu::Fix::Condition::is_array

only execute fixes if all path values are arrays

Catmandu::Fix::Condition::is_false

only execute fixes if all path values are the boolean false, 0 or "false"

Catmandu::Fix::Condition::is_null

only execute fixes if all path values are null

Catmandu::Fix::Condition::is_number

only execute fixes if all path values are numbers

Catmandu::Fix::Condition::is_object

only execute fixes if all path values are objects (unordered sets of name-value pairs)

Catmandu::Fix::Condition::is_string

only execute fixes if all path values are strings

Catmandu::Fix::Condition::is_true

only execute fixes if all path values are the boolean true, 1 or "true"

Catmandu::Fix::Condition::less_than

Excute fixes when a field is less than a value

Catmandu::Fix::Condition::valid

Execute fixes if the data passes validation

Catmandu::Fix::Has

helper class for creating Fix-es with (optional) parameters

Catmandu::Fix::Inlineable

Role for all Catmandu fixes that can be inlined

Catmandu::Fix::Parser

the parser of the Catmandu::Fix language

Catmandu::Fix::SimpleGetValue

helper class for creating emit Fix-es

Catmandu::Fix::add

shortcut for Catmandu::Fix::add_field

Catmandu::Fix::add_field

add or change the value of a HASH key or ARRAY index

Catmandu::Fix::add_to_exporter

Export a record as side effect

Catmandu::Fix::add_to_store

add matching values to a store as a side effect

Catmandu::Fix::append

add a suffix to the value of a field

Catmandu::Fix::array

creates an array out of a hash

Catmandu::Fix::assoc

associate two values as a hash key and value

Catmandu::Fix::capitalize

capitalize the value of a key

Catmandu::Fix::clone

create a clone of the data object

Catmandu::Fix::code

run arbitrary code as fix

Catmandu::Fix::collapse

convert nested data into a flat hash using the TT2 dot convention

Catmandu::Fix::compact

remove undefined values from an array

Catmandu::Fix::copy

shortcut for Catmandu::Fix::copy_field

Catmandu::Fix::copy_field

copy the value of one field to a new field

Catmandu::Fix::count

replace the value of an array or hash field with its count

Catmandu::Fix::cp

shortcut for Catmandu::Fix::copy_field

Catmandu::Fix::disassoc

inverse of assoc, transform a hash into an array of key value pairs

Catmandu::Fix::downcase

lowercase the value of a field

Catmandu::Fix::error

die with an error message

Catmandu::Fix::eval

eval and execute fixes defined in a field

Catmandu::Fix::expand

convert a flat hash into nested data using the TT2 dot convention

Catmandu::Fix::expand_date

expand a date field into year, month and date

Catmandu::Fix::export_to_string

convert the value of field using a named exporter

Catmandu::Fix::filter

Filter values out of an array based on a regular expression

Catmandu::Fix::flatten

flatten a nested array field

Catmandu::Fix::format

replace the value with a formatted (sprintf-like) version

Catmandu::Fix::from_json

replace a json field with the parsed value

Catmandu::Fix::hash

creates a hash out of an array

Catmandu::Fix::import

change the value of a HASH key or ARRAY index by replacing its value with imported data

Catmandu::Fix::import_from_string

Import data from a string into an array ref, using a named importer.

Catmandu::Fix::include

include fixes from another file

Catmandu::Fix::index

Find all positions of a (sub)string in a field

Catmandu::Fix::int

convert a value to an integer

Catmandu::Fix::join

shortcut for Catmandu::Fix::join_field

Catmandu::Fix::join_field

join the ARRAY values of a field into a string

Catmandu::Fix::log

Log::Any logger as fix

Catmandu::Fix::lookup

change the value of a HASH key or ARRAY index by looking up its value in a dictionary

Catmandu::Fix::lookup_in_store

change the value of a HASH key or ARRAY index by looking up its value in a store

Catmandu::Fix::mapping

move several fields by a lookup table

Catmandu::Fix::move

shortcut for Catmandu::Fix::move_field

Catmandu::Fix::move_field

move a field to another place in the data structure

Catmandu::Fix::mv

shortcut for Catmandu::Fix::move_field

Catmandu::Fix::nothing

does nothing (for testing)

Catmandu::Fix::parse_text

parses a text into an array or hash of values

Catmandu::Fix::paste

concatenate path values

Catmandu::Fix::perlcode

execute Perl code as fix function

Catmandu::Fix::prepend

add a prefix to the value of a field

Catmandu::Fix::random

create an random number in a field

Catmandu::Fix::reject

remove a record form the data

Catmandu::Fix::remove

shortcut for Catmandu::Fix::remove_field

Catmandu::Fix::remove_field

remove a field form the data

Catmandu::Fix::rename

rename fields with a regex

Catmandu::Fix::replace_all

search and replace using regex expressions

Catmandu::Fix::retain

delete everything except the paths given

Catmandu::Fix::retain_field

delete everything from a field except

Catmandu::Fix::reverse

reverse a string or an array

Catmandu::Fix::rm

shortcut for Catmandu::Fix::remove_field

Catmandu::Fix::search_in_store

use the value as query, and replace it by a search object

Catmandu::Fix::set

shortcut for Catmandu::Fix::set_field

Catmandu::Fix::set_array

add or change the value of a HASH key or ARRAY index to an array

Catmandu::Fix::set_field

add or change the value of a HASH key or ARRAY index

Catmandu::Fix::set_hash

add or change the value of a HASH key or ARRAY index to a hash

Catmandu::Fix::sleep

Do nothing for a specified amount of time

Catmandu::Fix::sort

shortcut for Catmandu::Fix::sort_field

Catmandu::Fix::sort_field

sort the values of an array

Catmandu::Fix::split

shortcut for Catmandu::Fix::split_field

Catmandu::Fix::split_field

split a string value in a field into an ARRAY

Catmandu::Fix::string

convert a value to a string

Catmandu::Fix::substring

extract a substring out of the value of a field

Catmandu::Fix::sum

replace the value of an array field with the sum of its elements

Catmandu::Fix::to_json

convert the value of a field to json

Catmandu::Fix::trim

trim leading and ending junk from the value of a field

Catmandu::Fix::uniq

strip duplicate values from an array

Catmandu::Fix::upcase

uppercase the value of a field

Catmandu::Fix::uri_decode

percent decode a URI

Catmandu::Fix::uri_encode

percent encode a URI

Catmandu::Fix::vacuum

delete all empty fields from your data

Catmandu::Fix::validate

validate data and keep errors

Catmandu::Fixable

a Catmandu role to apply fixes

Catmandu::Flushable

Optional role for flushable bags

Catmandu::Hits

Iterable object that wraps Catmandu::Store search hits

Catmandu::IdGenerator

A base role for identifier generators

Catmandu::IdGenerator::Mock

Generator of increasing identifiers

Catmandu::IdGenerator::UUID

Generator of UUID identifiers

Catmandu::Importer

Namespace for packages that can import

Catmandu::Importer::CSV

Package that imports CSV data

Catmandu::Importer::DKVP

Delimited key-value pairs importer

Catmandu::Importer::JSON

Package that imports JSON data

Catmandu::Importer::Mock

Mock importer used for testing purposes

Catmandu::Importer::Modules

list installed perl modules in a given namespace

Catmandu::Importer::Multi

Chain multiple importers together

Catmandu::Importer::Null

Null importer used for testing purposes

Catmandu::Importer::TSV

Package that imports tab-separated values

Catmandu::Importer::Text

Package that imports textual data

Catmandu::Importer::YAML

Package that imports YAML data

Catmandu::Interactive

An interactive command line interpreter of the Fix language

Catmandu::Iterable

Base role for all iterable Catmandu classes

Catmandu::IterableOnce

Role for iterable classes that can only iterate once

Catmandu::Iterator

Base class for all Catmandu iterators

Catmandu::Logger

A role for classes that need logging capabilities

Catmandu::MultiIterator

chain multiple iterators together

Catmandu::Paged

Base class for packages that need paging result sets

Catmandu::Path

Base role for Catmandu path implementations

Catmandu::Path::simple

The default Catmandu path syntax

Catmandu::Pluggable

A role for classes that need plugin capabilities

Catmandu::Plugin::Datestamps

Automatically add datestamps to Catmandu::Store records

Catmandu::Plugin::Readonly

Make stores or bags read-only

Catmandu::Plugin::Versioning

Automatically adds versioning to Catmandu::Store records

Catmandu::Sane

Package boilerplate

Catmandu::Searchable

Optional role for searchable stores

Catmandu::Serializer

Base class for all Catmandu Serializers

Catmandu::Serializer::json

A (de)serializer from and to json

Catmandu::Store

Namespace for packages that can make data persistent

Catmandu::Store::Hash

An in-memory store

Catmandu::Store::Hash::Bag

Bag implementation for the Hash store

Catmandu::Store::Multi

A store that adds data to multiple stores

Catmandu::Store::Multi::Bag

Bag implementation for the Multi store

Catmandu::TabularExporter

base role for tabular exporters like CSV

Catmandu::Transactional

Optional role for transactional stores

Catmandu::Util

A collection of utility functions

Catmandu::Util::Path

Path related utility functions

Catmandu::Util::Regex

Regex related utility functions

Catmandu::Validator

Namespace for packages that can validate items in Catmandu

Catmandu::Validator::Mock

Validate items based on a flag

Catmandu::Validator::Simple

Simple Validator for Catmandu

Provides

Catmandu::BadArg

in lib/Catmandu/Error.pm

Catmandu::BadFixArg

in lib/Catmandu/Error.pm

Catmandu::BadVal

in lib/Catmandu/Error.pm

Catmandu::Error::Source

in lib/Catmandu/Error.pm

Catmandu::Expander

in lib/Catmandu/Expander.pm

Catmandu::Fix::Namespace

in lib/Catmandu/Fix/Namespace.pm

Catmandu::Fix::Namespace::perl

in lib/Catmandu/Fix/Namespace/perl.pm

Catmandu::FixError

in lib/Catmandu/Error.pm

Catmandu::FixParseError

in lib/Catmandu/Error.pm

Catmandu::HTTPError

in lib/Catmandu/Error.pm

Catmandu::NoSuchFixPackage

in lib/Catmandu/Error.pm

Catmandu::NoSuchPackage

in lib/Catmandu/Error.pm

Catmandu::NotImplemented

in lib/Catmandu/Error.pm

Catmandu::Plugin::Readonly::Droppable

in lib/Catmandu/Plugin/Readonly/Droppable.pm

Catmandu::Plugin::Readonly::Searchable

in lib/Catmandu/Plugin/Readonly/Searchable.pm

Other files

To install Catmandu, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Catmandu

CPAN shell

perl -MCPAN -e shell
install Catmandu

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

Changes for version 1.2020 - 2023-02-08

Documentation

Modules

Provides

Other files

Module Install Instructions