Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add TTL option to Export #189

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from
Open

Add TTL option to Export #189

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 57 additions & 35 deletions lib/triagens/ArangoDb/Export.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,28 +19,28 @@
class Export
{
/**
* The connection object
* The connection object.
*
* @var Connection
*/
private $_connection = null;

/**
* The collection name or collection object
* The collection name or collection object.
*
* @var mixed
*/
private $_collection = null;

/**
* The current batch size (number of result documents retrieved per round-trip)
* The current batch size (number of result documents retrieved per round-trip).
*
* @var mixed
*/
private $_batchSize = null;

/**
* "flat" flag (if set, the query results will be treated as a simple array, not documents)
* "flat" flag (if set, the query results will be treated as a simple array, not documents).
*
* @var bool
*/
Expand All @@ -49,61 +49,73 @@ class Export
/**
* Flush flag (if set, then all documents from the collection that are currently only
* in the write-ahead log (WAL) will be moved to the collection's datafiles. This may cause
* an initial delay in the export, but will lead to the documents in the WAL not being
* an initial delay in the export, but will lead to the documents in the WAL not being
* excluded from the export run. If the flush flag is set to false, the documents still
* in the WAL may be missing in the export result.
*
* @var bool
*/
private $_flush = true;

/**
* The underlying collection type
* The underlying collection type.
*/
private $_type;

/**
* export restrictions - either null for no restrictions or an array with a "type" and a "fields" index
* export restrictions - either null for no restrictions or an array with a "type" and a "fields" index.
*
* @var mixed
*/
private $_restrictions;

/**
* optional limit for export - if specified and positive, will cap the amount of documents in the cursor to
* the specified value
* the specified value.
*
* @var int
*/
private $_limit = 0;

/**
* Count option index
* Cursor time to live.
*
* @var int
*/
private $_ttl = 0;

/**
* Count option index.
*/
const ENTRY_COUNT = 'count';

/**
* Batch size option index
* Batch size option index.
*/
const ENTRY_BATCHSIZE = 'batchSize';

/**
* Flush option index
* Flush option index.
*/
const ENTRY_FLUSH = 'flush';

/**
* Export restrictions
* Export restrictions.
*/
const ENTRY_RESTRICT = 'restrict';

/**
* Optional limit for the number of documents
* Optional limit for the number of documents.
*/
const ENTRY_LIMIT = 'limit';

/**
* Initialize the export
* Optional cursor's time to live.
*/
const ENTRY_TTL = 'ttl';

/**
* Initialize the export.
*
* @throws Exception
*
Expand All @@ -115,7 +127,7 @@ public function __construct(Connection $connection, $collection, array $data = a
{
$this->_connection = $connection;

if (! ($collection instanceof Collection)) {
if (!($collection instanceof Collection)) {
$collectionHandler = new CollectionHandler($this->_connection);
$collection = $collectionHandler->get($collection);
}
Expand All @@ -132,28 +144,32 @@ public function __construct(Connection $connection, $collection, array $data = a
if (isset($data[self::ENTRY_BATCHSIZE])) {
$this->setBatchSize($data[self::ENTRY_BATCHSIZE]);
}

if (isset($data[self::ENTRY_LIMIT])) {
$this->_limit = (int) $data[self::ENTRY_LIMIT];
}


if (isset($data[self::ENTRY_TTL])) {
$this->_ttl = (int) $data[self::ENTRY_TTL];
}

if (isset($data[self::ENTRY_RESTRICT]) &&
is_array($data[self::ENTRY_RESTRICT])) {
$restrictions = $data[self::ENTRY_RESTRICT];

if (! isset($restrictions["type"]) ||
if (! isset($restrictions["type"]) ||
! in_array($restrictions["type"], array("include", "exclude"), true)) {
// validate restrictions.type
throw new ClientException('Invalid restrictions type definition');
}

if (! isset($restrictions["fields"]) ||
if (! isset($restrictions["fields"]) ||
! is_array($restrictions["fields"])) {
// validate restrictions.fields
throw new ClientException('Invalid restrictions fields definition');
}
// all valid

// all valid
$this->_restrictions = $restrictions;
}

Expand All @@ -163,7 +179,7 @@ public function __construct(Connection $connection, $collection, array $data = a
}

/**
* Return the connection object
* Return the connection object.
*
* @return Connection - the connection object
*/
Expand All @@ -173,45 +189,50 @@ protected function getConnection()
}

/**
* Execute the export
* Execute the export.
*
* This will return the results as a Cursor. The cursor can then be used to iterate the results.
*
* @throws Exception
*
* @return ExportCursor
*/
public function execute()
{
$data = array(
self::ENTRY_FLUSH => $this->_flush,
self::ENTRY_COUNT => true
self::ENTRY_COUNT => true,
);

if ($this->_batchSize > 0) {
$data[self::ENTRY_BATCHSIZE] = $this->_batchSize;
}

if ($this->_limit > 0) {
$data[self::ENTRY_LIMIT] = $this->_limit;
}

if ($this->_ttl > 0) {
$data[self::ENTRY_TTL] = $this->_ttl;
}

if (is_array($this->_restrictions)) {
$data[self::ENTRY_RESTRICT] = $this->_restrictions;
}

$collection = $this->_collection;
if ($collection instanceof Collection) {
$collection = $collection->getName();
}

$url = UrlHelper::appendParamsUrl(Urls::URL_EXPORT, array("collection" => $collection));
$response = $this->_connection->post($url, $this->getConnection()->json_encode_wrapper($data));

return new ExportCursor($this->_connection, $response->getJson(), $this->getCursorOptions());
}

/**
* Set the batch size for the export
* Set the batch size for the export.
*
* The batch size is the number of results to be transferred
* in one server round-trip. If an export produces more documents
Expand All @@ -236,7 +257,7 @@ public function setBatchSize($value)
}

/**
* Get the batch size for the export
* Get the batch size for the export.
*
* @return int - current batch size value
*/
Expand All @@ -246,7 +267,7 @@ public function getBatchSize()
}

/**
* Return an array of cursor options
* Return an array of cursor options.
*
* @return array - array of options
*/
Expand All @@ -257,6 +278,7 @@ private function getCursorOptions()
ExportCursor::ENTRY_BASEURL => Urls::URL_EXPORT,
ExportCursor::ENTRY_TYPE => $this->_type
);

return $result;
}
}