/ 
Apache-Solr-1.12
/ Apache::Solr::XML

NAME

Apache::Solr::XML - Apache Solr (Lucene) client via XML

INHERITANCE

Apache::Solr::XML
  is an Apache::Solr

SYNOPSIS

my $solr = Apache::Solr::XML->new(...);
my $solr = Apache::Solr->new(format => 'XML', ...);

DESCRIPTION

Implement the Solr client, where the communication is in XML.

This module uses XML::LibXML to parse and construct XML.

Extends "DESCRIPTION" in Apache::Solr.

METHODS

Extends "METHODS" in Apache::Solr.

Constructors

Extends "Constructors" in Apache::Solr.

$class->new(%options)

Creates a new object. You may have objects shared the same LWP::UserAgent object, to share connections. Improves base, see "Constructors" in Apache::Solr

-Option            --Defined in     --Default
 agent               Apache::Solr     <created internally>
 autocommit          Apache::Solr     true
 core                Apache::Solr     undef
 field_key_simplify  Apache::Solr     true
 format              Apache::Solr     'XML'
 retry_max           Apache::Solr     60
 retry_wait          Apache::Solr     5
 server              Apache::Solr     <required>
 server_version      Apache::Solr     <latest>
agent => LWP::UserAgent-object
autocommit => BOOLEAN
core => $name
field_key_simplify => BOOLEAN
format => 'XML'|'JSON'
retry_max => COUNT
retry_wait => $seconds
server => $url
server_version => $version

Attributes

Extends "Attributes" in Apache::Solr.

$obj->agent()

Inherited, see "Attributes" in Apache::Solr

$obj->autocommit( [BOOLEAN] )

Inherited, see "Attributes" in Apache::Solr

$obj->core( [$core] )

Inherited, see "Attributes" in Apache::Solr

$obj->fieldKeySimplify()

Inherited, see "Attributes" in Apache::Solr

$obj->server( [$uri|STRING] )

Inherited, see "Attributes" in Apache::Solr

$obj->serverVersion()

Inherited, see "Attributes" in Apache::Solr

$obj->xmlsimple()

Commands

Extends "Commands" in Apache::Solr.

Helpers

Extends "Helpers" in Apache::Solr.

$obj->simpleDocument( $command, [$attributes, [$content]] )

Construct a simple XML structure.

$obj->simpleUpdate( $command, $attributes, [$content] )

DETAILS

Extends "DETAILS" in Apache::Solr.

DIAGNOSTICS

Fault: Cannot read document from $fn: $!

Cast by extractDocument()

Fault: Read error for document $fn: $!

Cast by extractDocument()

Fault: Solr request failed after $elapse seconds after $retries retries: $!

Cast by request()

Alert: Solr request failed with $code, $retries retries left: $!

Cast by request()

Error: Solr request failed with: $err

Cast by request()

Warning: deprecated solr $message

Cast by deprecated()

Error: extract requires document as file or string.

Cast by extractDocument()

Error: extractDocument() requires Solr v1.4 or higher.

Cast by extractDocument()

Error: field $field is not simple for a set.

Cast by expandSelect()

Warning: ignored solr $message

Cast by ignored()

Warning: removed solr $message

Cast by removed()

Error: rollback not supported by your solr server version.

Cast by rollback()

Error: set $set cannot be used per field, in $field.

Cast by expandSelect()

Error: unknown field set $set.

Cast by expandSelect()

SEE ALSO

This module is part of Apache-Solr version 1.12, built on July 15, 2026. Website: https://perl.overmeer.net/CPAN/

LICENSE

For contributors see file ChangeLog.

This software is copyright (c) 2012-2026 by Mark Overmeer.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.