How do I update my Solr schema on Acquia Search powered by SearchStax?

Acquia Search powered by SearchStax does not support the upload of schema or configset files. To update Solr schema, you must use Solr Schema API.

Updating Solr schema through Solr Schema API

For advanced changes, use Solr Schema API by sending POST requests to the /schema/ endpoint with the authentication token of the account. For more information, visit Solr Schema API documentation.

Supported commands

Send these commands as JSON in a POST request to /schema/:

You can include multiple commands in a single POST request. The system handles them in the specified order.

Authentication

All Schema API requests require an authorization token. Obtain the token from the Search API section on the SearchStax application dashboard. For additional information, refer to SearchStax Studio Search API.

Example: Change a tokenizer on a field type

1. Retrieve the current field type definition
   To obtain the existing definition, run this curl command:

   copy

   curl -H "Authorization: Token YOUR_AUTH_TOKEN" \
   "https://YOUR_SEARCHSTAX_ENDPOINT/schema/fieldtypes/text_unstemmed_sv?wt=json"

   The command returns the full field type definition including analyzers and tokenizers:

   copy

   {
         "fieldType": {
           "name": "text_unstemmed_sv",
           "class": "solr.TextField",
           "positionIncrementGap": "100",
           "queryAnalyzer": {
             "tokenizer": {
               "class": "solr.WhitespaceTokenizerFactory"
         }
       }
     }
   }

2. POST the updated definition

   To change the tokenizer from WhitespaceTokenizerFactory to StandardTokenizerFactory, use the replace-field-type command to send the full updated field type definition:

   copy

   curl -X POST \
         -H "Authorization: Token YOUR_AUTH_TOKEN" \
         "https://YOUR_SEARCHSTAX_ENDPOINT/schema" \
         -d '{
           "replace-field-type": {
             "name": "text_unstemmed_sv",
             "class": "solr.TextField",
             "positionIncrementGap": "100",
             "queryAnalyzer": {
               "tokenizer": {
                 "class": "solr.StandardTokenizerFactory"
               }
             }
           }
         }'

   A successful response returns:

   copy

   {
         "responseHeader": {
           "status": 0,
           "QTime": 3565
         }
       }

Run the GET request from step 1 again to ensure that the change is correct.

Limitations

• New files such as stopwords, synonyms, and protwords that are not in the current schema definition cannot be uploaded. You can only refer to files already in the configset.
• Manage synonyms and stopwords through the SearchStax UI.
• Contact SearchStax Support for assistance with the deployment of other text files such as protwords, accents, stoptags, and user dictionaries.

Additional tools

SearchStax provides a Python-based schema management tool that wraps the Schema API for common operations. Access the tool at: https://github.com/searchstax/searchstax-schema-management/.