METHODS¶

mkfields

    BEGIN {
        $CLASS->mkfields(@names);
    }

• Generates constants "TUPLE_$fieldname" => $fieldposition in $CLASS. Just Like if you say "use constant TUPLE_id => 0, TUPLE_f1 => 1, ...;"
• Generates $CLASS variable @fields containing field names, and a $CLASS method "FIELDS" returning @fields.
• Generates $CLASS variable %fields containing field names mapping to positions, and a $CLASS method "FIELDS_HASH" returning "\%fields".
• These @fields are applied to the "DEFAULT_SPACE", if fields were not set explicitly for that space.

declare_stored_procedure

    $CLASS->declare_stored_procedure(%args);
    
    $CLASS->declare_stored_procedure(
        name             => "box.do.something",                        # internal procedure name, in da box
        method_name      => "CallMyTestingStoredProcedure",            # will generate method named
        options          => { default => options },                    # MR::Tarantool::Box->Call \%options
        params           => [ qw{ P1 P2 P3 Param4 }],                  # names
    
        unpack_format    => "&LSC(L$)*",
    
        params_format    => [qw{ C S L a* }],
        params_default   => [ 1, 2, undef, 'the_default' ],            # undef's are mandatory params
    );
    
    ...
    
    my $data = $CLASS->CallMyTestingStoredProcedure(
        P1 => $val1,
        P2 => $val2,
        P3 => $val3,
        Param4 => $val3,
        { option => $value }, # optional
    ) or warn $CLASS->ErrorStr;

Declare a stored procedure. This generates $CLASS method $args{method_name} which calls Tarantool/Box procedure $args{name}, using $args{options} as default "\%options" for "MR::Tarantool::Box->Call" call. The generated method has the following prototype:

    $CLASS->CallMyTestingStoredProcedure( %sp_params, \%optional_options );

Parameters description:

%args:

%sp_params:

"Name => $value" pairs.

%optional_options:

Options to pass to MR::Taranatool::Box-Call|MR::Taranatool::Box/Call> method. This overrides %options values key-by-key.

Configuration methods

SERVER

Must return a string of ip:port of master server.

REPLICAS

Must return a comma separated string of ip:port pairs of replica servers (see "is_replica"). Server is chosen from the list randomly.

MR_TARANTOOL_BOX_CLASS

Must return name of the class implementing MR::Tarantool::Box interface, or it's descendant.

SPACES, RAISE, TIMEOUT, SELECT_TIMEOUT, RETRY, SELECT_RETRY, SOFT_RETRY, DEBUG

See corresponding arguments of MR::Tarantool::Box-new|MR::Tarantool::Box/new> method.

Add, Insert, Replace, UpdateMulti, Delete

These methods operate on "SERVER" only. See corresponding methods of MR::Tarantool::Box class.

Select, Call

These methods operate on "SERVER" at first, and then may try to query "REPLICAS".

See corresponding methods of MR::Tarantool::Box class.

These methods have additional %options params:

is_replica => \$is_result_from_replica

If this option is set, then if the query to "SERVER" fails, "REPLICAS" will be queried one-by-one until query succeeds or the list ends, and $is_result_from_replica will be set to "true", no matter whether any query succeeds or not.

Error, ErrorStr

Return error code or description (see <MR::Tarantool::Box|MR::Tarantool::Box/Error>).