neo4j-php-client/src/Contracts/SessionInterface.php at 95f60905fbc787ad1eafc01aace4c778926dbb99 · neo4j-php/neo4j-php-client · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
<?php

declare(strict_types=1);

/*
 * This file is part of the Laudis Neo4j package.
 *
 * (c) Laudis technologies <http://laudis.tech>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Laudis\Neo4j\Contracts;

use Laudis\Neo4j\Databags\Bookmark;
use Laudis\Neo4j\Databags\Statement;
use Laudis\Neo4j\Databags\TransactionConfiguration;
use Laudis\Neo4j\Exception\Neo4jException;
use Laudis\Neo4j\Types\CypherList;

/**
 * A lightweight container for causally chained sequences of transactions to carry out work.
 *
 * @template ResultFormat
 *
 * @extends TransactionInterface<ResultFormat>
 */
interface SessionInterface extends TransactionInterface
{
    /**
     * @param iterable<Statement> $statements
     *
     * @throws Neo4jException
     *
     * @return CypherList<ResultFormat>
     */
    public function runStatements(iterable $statements, ?TransactionConfiguration $config = null): CypherList;

    /**
     * @return ResultFormat
     */
    public function runStatement(Statement $statement, ?TransactionConfiguration $config = null);

    /**
     * @param iterable<string, scalar|iterable|null> $parameters
     *
     * @return ResultFormat
     */
    public function run(string $statement, iterable $parameters = [], ?TransactionConfiguration $config = null);

    /**
     * @psalm-param iterable<Statement>|null $statements
     *
     * @throws Neo4jException
     *
     * @deprecated
     * @see SessionInterface::beginTransaction use this method instead.
     *
     * @return UnmanagedTransactionInterface<ResultFormat>
     */
    public function openTransaction(?iterable $statements = null, ?TransactionConfiguration $config = null): UnmanagedTransactionInterface;

    /**
     * @psalm-param iterable<Statement>|null $statements
     *
     * @throws Neo4jException
     *
     * @return UnmanagedTransactionInterface<ResultFormat>
     */
    public function beginTransaction(?iterable $statements = null, ?TransactionConfiguration $config = null): UnmanagedTransactionInterface;

    /**
     * @template HandlerResult
     *
     * @param callable(TransactionInterface<ResultFormat>):HandlerResult $tsxHandler
     *
     * @return HandlerResult
     */
    public function writeTransaction(callable $tsxHandler, ?TransactionConfiguration $config = null);

    /**
     * @template HandlerResult
     *
     * @param callable(TransactionInterface<ResultFormat>):HandlerResult $tsxHandler
     *
     * @return HandlerResult
     */
    public function readTransaction(callable $tsxHandler, ?TransactionConfiguration $config = null);

    /**
     * @template HandlerResult
     *
     * @param callable(TransactionInterface<ResultFormat>):HandlerResult $tsxHandler
     *
     * @return HandlerResult
     */
    public function transaction(callable $tsxHandler, ?TransactionConfiguration $config = null);

//    public function getLastBookmark(): Bookmark;
}