Skip to content

Commit

Permalink
deploy: 4c3b439
Browse files Browse the repository at this point in the history
  • Loading branch information
@donhardman
donhardman committed Dec 25, 2024
1 parent 6b1eeff commit e2305b0
Show file tree
Hide file tree
Showing 5 changed files with 191 additions and 21 deletions.
188 changes: 176 additions & 12 deletions Manticoresearch/Buddy/Core/ManticoreSearch/Client.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,16 @@ <h2>Methods</h2>

<p><p>Set server URL of Manticore searchd to send requests to</p></p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8">
<a href="#method_getServerUrl">getServerUrl</a>()

<p><p>Get current server url</p></p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
Expand All @@ -237,6 +247,26 @@ <h2>Methods</h2>

<p><p>Send the request where request represents the SQL query to be send</p></p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
array
</div>
<div class="col-md-8">
<a href="#method_sendMultiRequest">sendMultiRequest</a>(array $requests)

<p><p>Send multiple requests with async and get all responses in single run</p></p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<a href="../../../../Manticoresearch/Buddy/Core/ManticoreSearch/Response.html"><abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Response">Response</abbr></a>
</div>
<div class="col-md-8">
<a href="#method_sendRequestToUrl">sendRequestToUrl</a>(string $url, string $request, string|null $path = null, bool $disableAgentHeader = false)

<p><p>Helper function that let us to send request to the specified url and setit back to original</p></p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
Expand Down Expand Up @@ -339,7 +369,7 @@ <h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method___construct">
<div class="location">at line 61</div>
<div class="location">at line 62</div>
<code> void
<strong>__construct</strong>(string|null $url = null)
</code>
Expand Down Expand Up @@ -382,7 +412,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_setServerUrl">
<div class="location">at line 82</div>
<div class="location">at line 83</div>
<code> <a href="../../../../Manticoresearch/Buddy/Core/ManticoreSearch/Client.html"><abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Client">Client</abbr></a>
<strong>setServerUrl</strong>(string $url)
</code>
Expand Down Expand Up @@ -419,13 +449,46 @@ <h4>Return Value</h4>



</div>
</div>

</div>
<div class="method-item">
<h3 id="method_getServerUrl">
<div class="location">at line 96</div>
<code> string
<strong>getServerUrl</strong>()
</code>
</h3>
<div class="details">




<div class="method-description">
<p><p>Get current server url</p></p>
</div>
<div class="tags">

<h4>Return Value</h4>

<table class="table table-condensed">
<tr>
<td>string</td>
<td></td>
</tr>
</table>




</div>
</div>

</div>
<div class="method-item">
<h3 id="method_sendRequest">
<div class="location">at line 98</div>
<div class="location">at line 107</div>
<code> <a href="../../../../Manticoresearch/Buddy/Core/ManticoreSearch/Response.html"><abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Response">Response</abbr></a>
<strong>sendRequest</strong>(string $request, string|null $path = null, bool $disableAgentHeader = false)
</code>
Expand Down Expand Up @@ -472,13 +535,114 @@ <h4>Return Value</h4>



</div>
</div>

</div>
<div class="method-item">
<h3 id="method_sendMultiRequest">
<div class="location">at line 163</div>
<code> array
<strong>sendMultiRequest</strong>(array $requests)
</code>
</h3>
<div class="details">




<div class="method-description">
<p><p>Send multiple requests with async and get all responses in single run</p></p>
</div>
<div class="tags">
<h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td>array</td>
<td>$requests</td>
<td></td>
</tr>
</table>


<h4>Return Value</h4>

<table class="table table-condensed">
<tr>
<td>array</td>
<td></td>
</tr>
</table>




</div>
</div>

</div>
<div class="method-item">
<h3 id="method_sendRequestToUrl">
<div class="location">at line 196</div>
<code> <a href="../../../../Manticoresearch/Buddy/Core/ManticoreSearch/Response.html"><abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Response">Response</abbr></a>
<strong>sendRequestToUrl</strong>(string $url, string $request, string|null $path = null, bool $disableAgentHeader = false)
</code>
</h3>
<div class="details">




<div class="method-description">
<p><p>Helper function that let us to send request to the specified url and setit back to original</p></p>
</div>
<div class="tags">
<h4>Parameters</h4>

<table class="table table-condensed">
<tr>
<td>string</td>
<td>$url</td>
<td></td>
</tr>
<tr>
<td>string</td>
<td>$request</td>
<td></td>
</tr>
<tr>
<td>string|null</td>
<td>$path</td>
<td></td>
</tr>
<tr>
<td>bool</td>
<td>$disableAgentHeader</td>
<td></td>
</tr>
</table>


<h4>Return Value</h4>

<table class="table table-condensed">
<tr>
<td><a href="../../../../Manticoresearch/Buddy/Core/ManticoreSearch/Response.html"><abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Response">Response</abbr></a></td>
<td></td>
</tr>
</table>




</div>
</div>

</div>
<div class="method-item">
<h3 id="method_setForceSync">
<div class="location">at line 154</div>
<div class="location">at line 218</div>
<code> <a href="../../../../Manticoresearch/Buddy/Core/ManticoreSearch/Client.html"><abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Client">Client</abbr></a>
<strong>setForceSync</strong>(bool $value = true)
</code>
Expand Down Expand Up @@ -521,7 +685,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_runAsyncRequest">
<div class="location">at line 166</div>
<div class="location">at line 230</div>
<code> protected string
<strong>runAsyncRequest</strong>(string $path, string $request, array $headers)
</code>
Expand Down Expand Up @@ -574,7 +738,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_runSyncRequest">
<div class="location">at line 196</div>
<div class="location">at line 262</div>
<code> protected string
<strong>runSyncRequest</strong>(string $path, string $request, array $headers)
</code>
Expand Down Expand Up @@ -627,7 +791,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_getAllTables">
<div class="location">at line 250</div>
<div class="location">at line 316</div>
<code> <a target="_blank" rel="noopener" href="https://www.php.net/Generator">Generator</a>
<strong>getAllTables</strong>(array $types = [])
</code>
Expand Down Expand Up @@ -684,7 +848,7 @@ <h4>Exceptions</h4>
</div>
<div class="method-item">
<h3 id="method_validateTables">
<div class="location">at line 274</div>
<div class="location">at line 340</div>
<code> array
<strong>validateTables</strong>(array $tables = [], array $types = [])
</code>
Expand Down Expand Up @@ -750,7 +914,7 @@ <h4>Exceptions</h4>
</div>
<div class="method-item">
<h3 id="method_hasTable">
<div class="location">at line 304</div>
<div class="location">at line 370</div>
<code> bool
<strong>hasTable</strong>(string $table)
</code>
Expand Down Expand Up @@ -794,7 +958,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_getSettings">
<div class="location">at line 314</div>
<div class="location">at line 380</div>
<code> <a href="../../../../Manticoresearch/Buddy/Core/ManticoreSearch/Settings.html"><abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Settings">Settings</abbr></a>
<strong>getSettings</strong>()
</code>
Expand Down Expand Up @@ -827,7 +991,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_fetchSettings">
<div class="location">at line 325</div>
<div class="location">at line 391</div>
<code> protected <a href="../../../../Manticoresearch/Buddy/Core/ManticoreSearch/Settings.html"><abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Settings">Settings</abbr></a>
<strong>fetchSettings</strong>()
</code>
Expand Down Expand Up @@ -860,7 +1024,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_fetchFuzzyVariations">
<div class="location">at line 384</div>
<div class="location">at line 450</div>
<code> array
<strong>fetchFuzzyVariations</strong>(string $query, string $table, bool $preserve = false, int $distance = 2, int $limit = 3)
</code>
Expand Down
10 changes: 5 additions & 5 deletions Manticoresearch/Buddy/Core/Network/Request.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,7 @@ <h4>Exceptions</h4>
</div>
<div class="method-item">
<h3 id="method_isElasticPath">
<div class="location">at line 251</div>
<div class="location">at line 254</div>
<code> protected bool
<strong>isElasticPath</strong>(string $path)
</code>
Expand Down Expand Up @@ -736,7 +736,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_validateInputFields">
<div class="location">at line 307</div>
<div class="location">at line 310</div>
<code> protected void
<strong>validateInputFields</strong>(array $payload, array $fields)
</code>
Expand Down Expand Up @@ -784,7 +784,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_detectMySQLTool">
<div class="location">at line 330</div>
<div class="location">at line 333</div>
<code> static protected <abbr title="Manticoresearch\Buddy\Core\Network\Manticoresearch\Buddy\Core\ManticoreSearch\MySQLTool">MySQLTool</abbr>|null
<strong>detectMySQLTool</strong>(string $query)
</code>
Expand Down Expand Up @@ -827,7 +827,7 @@ <h4>Return Value</h4>
</div>
<div class="method-item">
<h3 id="method_removeComments">
<div class="location">at line 346</div>
<div class="location">at line 349</div>
<code> static protected string
<strong>removeComments</strong>(string $query)
</code>
Expand Down Expand Up @@ -879,7 +879,7 @@ <h4>Exceptions</h4>
</div>
<div class="method-item">
<h3 id="method_getOutputFormat">
<div class="location">at line 374</div>
<div class="location">at line 377</div>
<code> <abbr title="Manticoresearch\Buddy\Core\Network\OutputFormat">OutputFormat</abbr>
<strong>getOutputFormat</strong>()
</code>
Expand Down
10 changes: 8 additions & 2 deletions doc-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,9 @@ <h2 id="letterA">A</h2>
<abbr title="Manticoresearch\Buddy\Core\Error\GenericError">GenericError</abbr>::getResponseErrorCode</a>() &mdash; <em>Method in class <a href="Manticoresearch/Buddy/Core/Error/GenericError.html"><abbr title="Manticoresearch\Buddy\Core\Error\GenericError">GenericError</abbr></a></em></dt>
<dd><p>Client HTTP error code 0 when proxy original one</p></dd><dt><a href="Manticoresearch/Buddy/Core/Error/GenericError.html#method_getProxyOriginalError">
<abbr title="Manticoresearch\Buddy\Core\Error\GenericError">GenericError</abbr>::getProxyOriginalError</a>() &mdash; <em>Method in class <a href="Manticoresearch/Buddy/Core/Error/GenericError.html"><abbr title="Manticoresearch\Buddy\Core\Error\GenericError">GenericError</abbr></a></em></dt>
<dd></dd><dt><a href="Manticoresearch/Buddy/Core/ManticoreSearch/Client.html#method_getAllTables">
<dd></dd><dt><a href="Manticoresearch/Buddy/Core/ManticoreSearch/Client.html#method_getServerUrl">
<abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Client">Client</abbr>::getServerUrl</a>() &mdash; <em>Method in class <a href="Manticoresearch/Buddy/Core/ManticoreSearch/Client.html"><abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Client">Client</abbr></a></em></dt>
<dd><p>Get current server url</p></dd><dt><a href="Manticoresearch/Buddy/Core/ManticoreSearch/Client.html#method_getAllTables">
<abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Client">Client</abbr>::getAllTables</a>() &mdash; <em>Method in class <a href="Manticoresearch/Buddy/Core/ManticoreSearch/Client.html"><abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Client">Client</abbr></a></em></dt>
<dd><p>Get all tables for this instance by running SHOW TABLES
And filter only required types or any if not specified</p></dd><dt><a href="Manticoresearch/Buddy/Core/ManticoreSearch/Client.html#method_getSettings">
Expand Down Expand Up @@ -701,7 +703,11 @@ <h2 id="letterA">A</h2>
<abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Client">Client</abbr>::setServerUrl</a>() &mdash; <em>Method in class <a href="Manticoresearch/Buddy/Core/ManticoreSearch/Client.html"><abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Client">Client</abbr></a></em></dt>
<dd><p>Set server URL of Manticore searchd to send requests to</p></dd><dt><a href="Manticoresearch/Buddy/Core/ManticoreSearch/Client.html#method_sendRequest">
<abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Client">Client</abbr>::sendRequest</a>() &mdash; <em>Method in class <a href="Manticoresearch/Buddy/Core/ManticoreSearch/Client.html"><abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Client">Client</abbr></a></em></dt>
<dd><p>Send the request where request represents the SQL query to be send</p></dd><dt><a href="Manticoresearch/Buddy/Core/ManticoreSearch/Client.html#method_setForceSync">
<dd><p>Send the request where request represents the SQL query to be send</p></dd><dt><a href="Manticoresearch/Buddy/Core/ManticoreSearch/Client.html#method_sendMultiRequest">
<abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Client">Client</abbr>::sendMultiRequest</a>() &mdash; <em>Method in class <a href="Manticoresearch/Buddy/Core/ManticoreSearch/Client.html"><abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Client">Client</abbr></a></em></dt>
<dd><p>Send multiple requests with async and get all responses in single run</p></dd><dt><a href="Manticoresearch/Buddy/Core/ManticoreSearch/Client.html#method_sendRequestToUrl">
<abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Client">Client</abbr>::sendRequestToUrl</a>() &mdash; <em>Method in class <a href="Manticoresearch/Buddy/Core/ManticoreSearch/Client.html"><abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Client">Client</abbr></a></em></dt>
<dd><p>Helper function that let us to send request to the specified url and setit back to original</p></dd><dt><a href="Manticoresearch/Buddy/Core/ManticoreSearch/Client.html#method_setForceSync">
<abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Client">Client</abbr>::setForceSync</a>() &mdash; <em>Method in class <a href="Manticoresearch/Buddy/Core/ManticoreSearch/Client.html"><abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Client">Client</abbr></a></em></dt>
<dd><p>Force to use sync client instead of async detection</p></dd><dt><a href="Manticoresearch/Buddy/Core/ManticoreSearch/Response.html#method_setMeta">
<abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Response">Response</abbr>::setMeta</a>() &mdash; <em>Method in class <a href="Manticoresearch/Buddy/Core/ManticoreSearch/Response.html"><abbr title="Manticoresearch\Buddy\Core\ManticoreSearch\Response">Response</abbr></a></em></dt>
Expand Down
2 changes: 1 addition & 1 deletion doctum-search.json
View file

Large diffs are not rendered by default.

Loading

0 comments on commit e2305b0

Please sign in to comment.