Catman...er::XSD(3pm)

📦
version 0.05 · 5 versions
, in debian bookworm, ubuntu noble

💖 Catmandu::Importer::XSD 💖

okay bestie, gather round, because this one is a whole mood. we're looking at Catmandu::Importer::XSD, a page from the User Contributed Perl Documentation set (the header line calls it Catman...er::XSD(3pm), which is giving "truncated by the terminal, but make it fashion" 💅).

✨ NAME ✨

Catmandu::Importer::XSD — Import and validate serialized XML documents 🦋

🌸 SYNOPSIS 🌸

    # Compile an XSD schema file and parse one shiporder.xml file
    catmandu convert XSD --root '{}shiporder'
                         --schemas demo/order/*.xsd
                         to YAML < shiporder.xml

    # Same as above but parse more than one file into an array of records
    catmandu convert XSD --root '{}shiporder'
                         --schemas demo/order/*.xsd
                         --files 'data/*.xml'
                         to YAML

    # Same as above but all array of records are in a XML container file
    catmandu convert XSD --root '{}shiporder'
                         --schemas demo/order/*.xsd
                         --xpath '/Container/List//Record/Payload/*'
                         to YAML < data/container.xml

    # In Perl
    use Catmandu;

    my $importer = Catmandu->importer('XSD',
                file => 'ex/data.xml'
                root => ...,
                schemas => [ ...]
    );

    my $n = $importer->each(sub {
        my $hashref = $_[0];
        # ...
    });

no cap, that last bit is the one you'll actually use in your Perl scripts 👑

💜 DESCRIPTION 💜

okay so this is a Catmandu::Importer — and its whole job? parsing and validating XML data using one or more XSD schema files. it's giving "glow up your XML, but with receipts" ✨

🎀 CONFIGURATION 🎀

  • file — read input from a local file, and you give it the path. alternatively you can hand it a scalar reference and it'll read from that string instead. iconic flexibility 🫶
  • fh — read input from an IO::Handle. if you don't specify one, Catmandu::Util::io is used to build the input stream from the "file" argument, or by falling back to STDIN. default queen behavior 💅
  • files — optional! instead of reading content from standard input, use the 'files' parameter as a glob for one or more filenames. e.g.
    catmandu ... --files 'data/input/*.xml'
  • examples — optional. doesn't actually do anything — it just shows you an example output of how a document should be structured in the given XSD scheme. a little preview, a little vibe check 👀 e.g.
    catmandu convert XSD --root {}shiporder --schemas "t/demo/ead/*xsd" --example 1 to YAML
  • fix — an ARRAY of one or more fixes or file scripts that get applied to imported items. your lil makeover station 🧚
  • root — Required. the name (and namespace) of the root element of the XML document. e.g.:
    {}shiporder
    {http://www.loc.gov/mods/v3}mods
    {urn:isbn:1-931666-22-9}ead
  • schemas — Required. an array or comma separated list of XSD schema locations.
  • xpath — optional. an XPath expression: the XML container in which the PNX record can be found. default is:
    /oai:OAI-PMH/oai:ListRecords//oai:record/oai:metadata/*
  • prefixes — optional. an array or comma delimited string of namespace prefixes to be used when handling XML files. e.g.
    # On the command line:
    catmandu ... --prefixes ead:urn:isbn:1-931666-22-9,...

    # In Perl
    prefixes => [
        ead => 'urn:isbn:1-931666-22-9' ,
        ... => ...
    ]
  • mixed — optional. how mixed element content gets handled. one of ATTRIBUTES (that's the default), TEXTUAL, STRUCTURAL, XML_NODE, XML_STRING, or a CODE reference. see also Catmandu::XSD and XML::Compile::Translate::Reader.
  • any_element — optional. how <any"> content in schemas gets handled. one of TAKE_ALL (default: process as XML::LibXML::Node), SKIP_ALL (just ignore these), XML_STRING (process as string), or CODE (provide a reference to parse the data). see XML::Compile::Translate::Reader.

🦋 METHODS 🦋

every Catmandu::Importer is a Catmandu::Iterable, so all its methods are inherited. periodt. 💅

🌈 SEE ALSO 🌈

  • Catmandu::Importer
  • Catmandu::XSD

👑 AUTHOR 👑

Patrick Hochstenbach, "patrick.hochstenbach at ugent.be" — legend behavior, fr fr 🫶

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See <http://dev.perl.org/licenses/> for more information.

and that's the whole page, bestie! 🎀 this one shipped as perl v5.36.0, dated 2022-11-29, under the header Catman...er::XSD(3pm) — go forth and validate your XML, you absolute main character 🌟💜

📦 where this page comes from