Skip to content

fix[indexes]: Inverted index to use default options #21

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

Merged
merged 3 commits into from
Oct 11, 2025
Merged

fix[indexes]: Inverted index to use default options #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4eb0764
fix[indexes]: Inverted index to use default options as defined in its…
lucassouzavieira Oct 11, 2025
9a54948
chore[docs]: rebuild documentation
lucassouzavieira Oct 11, 2025
cd91dc0
refactor[collection]: group index related methods into 'IndexableTrait'
lucassouzavieira Oct 11, 2025
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
196 changes: 194 additions & 2 deletions docs/classes/ArangoDB-AQL-AQL.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,14 +309,198 @@ <h3 id="toc">



<h4 id="toc-methods">
Methods
<a href="classes/ArangoDB-AQL-AQL.html#toc-methods" class="headerlink"><i class="fas fa-link"></i></a>

</h4>
<dl class="phpdocumentor-table-of-contents">
<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/ArangoDB-AQL-AQL.html#method_functions">functions()</a>
<span>
&nbsp;: <a href="classes/ArangoDB-DataStructures-ArrayList.html"><abbr title="\ArangoDB\DataStructures\ArrayList">ArrayList</abbr></a> </span>
</dt>
<dd>Returns all registered AQL user functions.</dd>

<dt class="phpdocumentor-table-of-contents__entry -method -public">
<a class="" href="classes/ArangoDB-AQL-AQL.html#method_validateQuery">validateQuery()</a>
<span>
&nbsp;: bool </span>
</dt>
<dd>Validates a given AQL statement</dd>

</dl>








<section class="phpdocumentor-methods">
<h3 class="phpdocumentor-elements__header" id="methods">
Methods
<a href="classes/ArangoDB-AQL-AQL.html#methods" class="headerlink"><i class="fas fa-link"></i></a>

</h3>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_functions">
functions()
<a href="classes/ArangoDB-AQL-AQL.html#method_functions" class="headerlink"><i class="fas fa-link"></i></a>

</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/AQL.php"><a href="files/src-aql-aql.html"><abbr title="src/AQL/AQL.php">AQL.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">63</span>

<a href="classes/ArangoDB-AQL-AQL.html#source-view.63" class="phpdocumentor-element-found-in__source" data-line="63" data-modal="source-view" data-src="files/src/AQL/AQL.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Returns all registered AQL user functions.</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">functions</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/ArangoDB-Connection-Connection.html"><abbr title="\ArangoDB\Connection\Connection">Connection</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$connection</span></span><span class="phpdocumentor-signature__argument"><span>[</span><span>, </span><span class="phpdocumentor-signature__argument__return-type">string&nbsp;</span><span class="phpdocumentor-signature__argument__name">$namespace</span><span> = </span><span class="phpdocumentor-signature__argument__default-value">&quot;&quot;</span><span> ]</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type"><a href="classes/ArangoDB-DataStructures-ArrayList.html"><abbr title="\ArangoDB\DataStructures\ArrayList">ArrayList</abbr></a></span></code>

<div class="phpdocumentor-label-line">
</div>


<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$connection</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/ArangoDB-Connection-Connection.html"><abbr title="\ArangoDB\Connection\Connection">Connection</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Connection object to use.</p>
</section>

</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$namespace</span>
: <span class="phpdocumentor-signature__argument__return-type">string</span>
= <span class="phpdocumentor-signature__argument__default-value">&quot;&quot;</span> </dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Returns all registered AQL user functions from namespace 'namespace' under result.</p>
</section>

</dd>
</dl>


<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/ArangoDB-AQL-AQL.html#method_functions#tags" class="headerlink"><i class="fas fa-link"></i></a>

</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/ArangoDB-Exceptions-ServerException.html"><abbr title="\ArangoDB\Exceptions\ServerException">ServerException</abbr></a>|<abbr title="\GuzzleHttp\Exception\GuzzleException">GuzzleException</abbr></span>


</dd>
</dl>



<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type"><a href="classes/ArangoDB-DataStructures-ArrayList.html"><abbr title="\ArangoDB\DataStructures\ArrayList">ArrayList</abbr></a></span>
&mdash;
<section class="phpdocumentor-description"><p>ArrayList with all AQL functions from server.</p>
</section>

</section>

</article>
<article
class="phpdocumentor-element
-method
-public
-static "
>
<h4 class="phpdocumentor-element__name" id="method_validateQuery">
validateQuery()
<a href="classes/ArangoDB-AQL-AQL.html#method_validateQuery" class="headerlink"><i class="fas fa-link"></i></a>

</h4>
<aside class="phpdocumentor-element-found-in">
<abbr class="phpdocumentor-element-found-in__file" title="src/AQL/AQL.php"><a href="files/src-aql-aql.html"><abbr title="src/AQL/AQL.php">AQL.php</abbr></a></abbr>
:
<span class="phpdocumentor-element-found-in__line">35</span>

<a href="classes/ArangoDB-AQL-AQL.html#source-view.35" class="phpdocumentor-element-found-in__source" data-line="35" data-modal="source-view" data-src="files/src/AQL/AQL.php.txt"></a>
</aside>

<p class="phpdocumentor-summary">Validates a given AQL statement</p>

<code class="phpdocumentor-code phpdocumentor-signature ">
<span class="phpdocumentor-signature__visibility">public</span>
<span class="phpdocumentor-signature__static">static</span> <span class="phpdocumentor-signature__name">validateQuery</span><span>(</span><span class="phpdocumentor-signature__argument"><span class="phpdocumentor-signature__argument__return-type"><a href="classes/ArangoDB-AQL-Contracts-StatementInterface.html"><abbr title="\ArangoDB\AQL\Contracts\StatementInterface">StatementInterface</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$statement</span></span><span class="phpdocumentor-signature__argument"><span>, </span><span class="phpdocumentor-signature__argument__return-type"><a href="classes/ArangoDB-Connection-Connection.html"><abbr title="\ArangoDB\Connection\Connection">Connection</abbr></a>&nbsp;</span><span class="phpdocumentor-signature__argument__name">$connection</span></span><span>)</span><span> : </span><span class="phpdocumentor-signature__response_type">bool</span></code>

<div class="phpdocumentor-label-line">
</div>


<h5 class="phpdocumentor-argument-list__heading">Parameters</h5>
<dl class="phpdocumentor-argument-list">
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$statement</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/ArangoDB-AQL-Contracts-StatementInterface.html"><abbr title="\ArangoDB\AQL\Contracts\StatementInterface">StatementInterface</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Statement to be validated.</p>
</section>

</dd>
<dt class="phpdocumentor-argument-list__entry">
<span class="phpdocumentor-signature__argument__name">$connection</span>
: <span class="phpdocumentor-signature__argument__return-type"><a href="classes/ArangoDB-Connection-Connection.html"><abbr title="\ArangoDB\Connection\Connection">Connection</abbr></a></span>
</dt>
<dd class="phpdocumentor-argument-list__definition">
<section class="phpdocumentor-description"><p>Connection object to use.</p>
</section>

</dd>
</dl>


<h5 class="phpdocumentor-tag-list__heading" id="tags">
Tags
<a href="classes/ArangoDB-AQL-AQL.html#method_validateQuery#tags" class="headerlink"><i class="fas fa-link"></i></a>

</h5>
<dl class="phpdocumentor-tag-list">
<dt class="phpdocumentor-tag-list__entry">
<span class="phpdocumentor-tag__name">throws</span>
</dt>
<dd class="phpdocumentor-tag-list__definition">
<span class="phpdocumentor-tag-link"><a href="classes/ArangoDB-AQL-Exceptions-AQLException.html"><abbr title="\ArangoDB\AQL\Exceptions\AQLException">AQLException</abbr></a>|<abbr title="\GuzzleHttp\Exception\GuzzleException">GuzzleException</abbr></span>


</dd>
</dl>



<section>
<h5 class="phpdocumentor-return-value__heading">Return values</h5>
<span class="phpdocumentor-signature__response_type">bool</span>
</section>

</article>
</section>

<div class="phpdocumentor-modal" id="source-view">
<div class="phpdocumentor-modal-bg" data-exit-button></div>
<div class="phpdocumentor-modal-container">
Expand Down Expand Up @@ -422,10 +606,18 @@ <h3 id="toc">
<li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
<li>
<ul class="phpdocumentor-list -clean">
</ul>
<li><a href="classes/ArangoDB-AQL-AQL.html#toc-methods">Methods</a></li>
</ul>
</li>


<li class="phpdocumentor-on-this-page-section__title">Methods</li>
<li>
<ul class="phpdocumentor-list -clean">
<li class=""><a href="classes/ArangoDB-AQL-AQL.html#method_functions">functions()</a></li>
<li class=""><a href="classes/ArangoDB-AQL-AQL.html#method_validateQuery">validateQuery()</a></li>
</ul>
</li>
</ul>
</section>

Expand Down
Loading