Merge pull request #113 from pantheon-systems/cms-387-select

CMS-387: Add new select command.

README.md

@@ -245,4 +245,5 @@ with the concept usage in a Solr context:
 * `drush search_api_pantheon:diagnose` (sapd) The DIAGNOSE command will check the various pieces of the Search API install
   and throw errors on the pieces that are not working. This command will develop further as the module nears general availability.
 
-*
+* `drush search_api_pantheon:select` (saps) This command will run the given query against Solr server. It's recommended to use
+  `?debug=true` in any Solr page to get a good query to pass to this command to debug results.

drush.services.yml

@@ -9,3 +9,8 @@ services:
     arguments: [ "@logger.factory", "@search_api_pantheon.pantheon_guzzle", "@search_api_pantheon.schema_poster" ]
     tags:
       - { name: drush.command }
+  search_api_pantheon.drush_query:
+    class: \Drupal\search_api_pantheon\Commands\Query
+    arguments: [ "@logger.factory", "@search_api_pantheon.pantheon_guzzle", "@search_api_pantheon.endpoint", "@search_api_pantheon.solarium_client" ]
+    tags:
+      - { name: drush.command }

src/Commands/Query.php

@@ -0,0 +1,116 @@
+<?php
+
+namespace Drupal\search_api_pantheon\Commands;
+
+use Drupal\Core\Logger\LoggerChannelFactoryInterface;
+use Drupal\search_api_pantheon\Services\Endpoint;
+use Drupal\search_api_pantheon\Services\PantheonGuzzle;
+use Drupal\search_api_pantheon\Services\SolariumClient;
+use Drush\Commands\DrushCommands;
+use Solarium\Core\Query\Result\ResultInterface;
+
+/**
+ * A Drush command file.
+ *
+ * In addition to this file, you need a drush.services.yml
+ * in root of your module, and a composer.json file that provides the name
+ * of the services file to use.
+ *
+ * See these files for an example of injecting Drupal services:
+ *   - http://cgit.drupalcode.org/devel/tree/src/Commands/DevelCommands.php
+ *   - http://cgit.drupalcode.org/devel/tree/drush.services.yml
+ */
+class Query extends DrushCommands {
+
+  protected PantheonGuzzle $pantheonGuzzle;
+  protected Endpoint $endpoint;
+  protected SolariumClient $solr;
+
+  /**
+   * Class Constructor.
+   *
+   * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $loggerChannelFactory
+   *   Injected by container.
+   * @param \Drupal\search_api_pantheon\Services\PantheonGuzzle $pantheonGuzzle
+   *   Injected by container.
+   * @param \Drupal\search_api_pantheon\Services\Endpoint $endpoint
+   *   Injected by container.
+   * @param \Drupal\search_api_pantheon\Services\SolariumClient $solariumClient
+   *   Injected by container.
+   */
+  public function __construct(
+        LoggerChannelFactoryInterface $loggerChannelFactory,
+        PantheonGuzzle $pantheonGuzzle,
+        Endpoint $endpoint,
+        SolariumClient $solariumClient
+    ) {
+    $this->logger = $loggerChannelFactory->get('SearchAPIPantheon Drush');
+    $this->pantheonGuzzle = $pantheonGuzzle;
+    $this->endpoint = $endpoint;
+    $this->solr = $solariumClient;
+  }
+
+  /**
+   * Search_api_pantheon:select.
+   *
+   * @usage search-api-pantheon:select <query>
+   *   Runs a select query against Pantheon Solr.
+   *
+   * @command search-api-pantheon:select
+   *
+   * @option wt Output format
+   * @option rows Number of rows to return
+   * @option qf Query fields
+   * @option defType Default search type
+   * @option omitHeader Do not output header
+   * @option fields Fields to return
+   *
+   * @aliases saps
+   *
+   * @throws \Drupal\search_api_solr\SearchApiSolrException
+   * @throws \JsonException
+   * @throws \Exception
+   */
+  public function select($query, $options = [
+    'wt' => 'json',
+    'rows' => 10,
+    'qf' => '',
+    'defType' => 'edismax',
+    'omitHeader' => 'true',
+    'fields' => 'ss_search_api_id,ss_search_api_language,score,hash',
+  ]) {
+    $this->logger->notice('Running a select query against Pantheon Solr.');
+
+    $this->logger->notice('Query: ' . urldecode($query));
+    $options['query'] = urldecode($query);
+
+    $query_object = $this->solr->createSelect($options);
+    $query_object->setResponseWriter($options['wt']);
+
+    if ($options['defType']) {
+      $query_object->addParam('defType', $options['defType']);
+    }
+    if ($options['omitHeader']) {
+      $query_object->setOmitHeader(TRUE);
+    }
+    if ($options['qf']) {
+      $query_object->addParam('qf', $options['qf']);
+    }
+
+    $query_object->addParam('TZ', 'UTC');
+
+    $result = $this->solr->execute($query_object);
+
+    if ($result instanceof ResultInterface) {
+      $this->logger->notice('Query executed successfully.');
+      $this->logger->notice('Query result:');
+      $this->logger->notice(json_encode($result->getData(), JSON_PRETTY_PRINT));
+    }
+    else {
+      $this->logger->error('Query failed.');
+      $this->logger->error('Query result:');
+      $this->logger->error(json_encode($result->getData(), JSON_PRETTY_PRINT));
+    }
+  }
+
+}