Search index schema

The schema defines the relationship between data in a table and a search index.

To create or alter a search index schema, use CQL commands like CREATE SEARCH INDEX and ALTER SEARCH INDEX SCHEMA.

For more information and examples, see Create a search index with default values and DSE Search index quickstart.

View search index schema and config

Search index schema and config are stored internally in the database. When you modify a search index schema or config, the changes are pending.

Use the CQL shell DESCRIBE SEARCH INDEX command to view the pending schema, and then use the CQL RELOAD SEARCH INDEX command to apply the pending changes to the active (in use) search index.

The DESCRIBE commands are part of the CQL shell. They aren’t available in the Cassandra drivers.

CQL shell DESCRIBE SEARCH INDEX

Use the CQL shell command DESCRIBE SEARCH INDEX to view active and pending schemas and configs:

  • Show the active index config:

    DESCRIBE ACTIVE SEARCH INDEX CONFIG ON demo.health_data;

    The results are shown in XML. For an example and information about the config elements, see Search index configuration.

  • Show the pending search index config or schema before it is active.

    For example, to view the pending index schema for demo.health_data:

    DESCRIBE PENDING SEARCH INDEX SCHEMA ON demo.health_data;

    The results are shown in XML:

    <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    <schema name="autoSolrSchema" version="1.5">
      <types>
        <fieldType class="org.apache.solr.schema.TextField" name="TextField">
          <analyzer>
            <tokenizer class="solr.StandardTokenizerFactory"/>
            <filter class="solr.LowerCaseFilterFactory"/>
          </analyzer>
        </fieldType>
        <fieldType class="org.apache.solr.schema.TrieIntField" name="TrieIntField"/>
      </types>
      <fields>
        <field indexed="true" multiValued="false" name="grade_completed" type="TextField"/>
        <field indexed="true" multiValued="false" name="diagnosed_thyroid_disease" type="TextField"/>
        <field indexed="true" multiValued="false" name="pets" type="TextField"/>
        <field indexed="true" multiValued="false" name="secondary_smoke" type="TextField"/>
        <field indexed="true" multiValued="false" name="diagnosed_lupus" type="TextField"/>
        <field indexed="true" multiValued="false" name="gender" type="TextField"/>
        <field indexed="true" multiValued="false" name="birthplace" type="TextField"/>
        <field docValues="true" indexed="true" multiValued="false" name="income_group" type="TrieIntField"/>
        <field indexed="true" multiValued="false" name="marital_status" type="TextField"/>
        <field docValues="true" indexed="true" multiValued="false" name="age_months" type="TrieIntField"/>
        <field indexed="true" multiValued="false" name="bird" type="TextField"/>
        <field indexed="true" multiValued="false" name="hay_fever" type="TextField"/>
        <field indexed="true" multiValued="false" name="diagnosed_hay_fever" type="TextField"/>
        <field indexed="true" multiValued="false" name="routine_medical_coverage" type="TextField"/>
        <field indexed="true" multiValued="false" name="annual_income_20000" type="TextField"/>
        <field indexed="true" multiValued="false" name="exam_status" type="TextField"/>
        <field indexed="true" multiValued="false" name="other_pet" type="TextField"/>
        <field indexed="true" multiValued="false" name="diagnosed_stroke" type="TextField"/>
        <field indexed="true" multiValued="false" name="employer_paid_plan" type="TextField"/>
        <field docValues="true" indexed="true" multiValued="false" name="family_sequence" type="TrieIntField"/>
        <field indexed="true" multiValued="false" name="diagnosed_cataracts" type="TextField"/>
        <field indexed="true" multiValued="false" name="major_medical_coverage" type="TextField"/>
        <field indexed="true" multiValued="false" name="diagnosed_gout" type="TextField"/>
        <field indexed="true" multiValued="false" name="age_unit" type="TextField"/>
        <field indexed="true" multiValued="false" name="goiter" type="TextField"/>
        <field indexed="true" multiValued="false" name="chronic_bronchitis" type="TextField"/>
        <field indexed="true" multiValued="false" name="county" type="TextField"/>
        <field docValues="true" indexed="true" multiValued="false" name="num_smokers" type="TrieIntField"/>
        <field indexed="true" multiValued="false" name="screening_month" type="TextField"/>
        <field indexed="true" multiValued="false" name="diagnosed_emphysema" type="TextField"/>
        <field indexed="true" multiValued="false" name="diagnosed_other_cancer" type="TextField"/>
        <field docValues="true" indexed="true" multiValued="false" name="id" type="TrieIntField"/>
        <field indexed="true" multiValued="false" name="dental_coverage" type="TextField"/>
        <field indexed="true" multiValued="false" name="health_status" type="TextField"/>
        <field docValues="true" indexed="true" multiValued="false" name="monthly_income_total" type="TrieIntField"/>
        <field indexed="true" multiValued="false" name="fish" type="TextField"/>
        <field indexed="true" multiValued="false" name="dog" type="TextField"/>
        <field indexed="true" multiValued="false" name="asthma" type="TextField"/>
        <field indexed="true" multiValued="false" name="ethnicity" type="TextField"/>
        <field docValues="true" indexed="true" multiValued="false" name="age" type="TrieIntField"/>
        <field indexed="true" multiValued="false" name="diagnosed_asthma" type="TextField"/>
        <field indexed="true" multiValued="false" name="race_ethnicity" type="TextField"/>
        <field indexed="true" multiValued="false" name="diagnosed_congestive_heart_failure" type="TextField"/>
        <field docValues="true" indexed="true" multiValued="false" name="family_size" type="TrieIntField"/>
        <field indexed="true" multiValued="false" name="race" type="TextField"/>
        <field indexed="true" multiValued="false" name="thyroid_disease" type="TextField"/>
        <field indexed="true" multiValued="false" name="bronchitis" type="TextField"/>
        <field docValues="true" indexed="true" multiValued="false" name="household_size" type="TrieIntField"/>
        <field indexed="true" multiValued="false" name="cat" type="TextField"/>
        <field indexed="true" multiValued="false" name="diagnosed_goiter" type="TextField"/>
        <field indexed="true" multiValued="false" name="diagnosed_skin_cancer" type="TextField"/>
        <field indexed="true" multiValued="false" name="fips" type="TextField"/>
      </fields>
      <uniqueKey>(id,age)</uniqueKey>
    </schema>

Was this helpful?

Give Feedback

How can we improve the documentation?

© Copyright IBM Corporation 2026 | Privacy policy | Terms of use |  Manage Privacy Choices

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: Contact IBM