commonMain.kotbase.IndexBuilder.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of couchbase-lite Show documentation

Couchbase Lite Community Edition for Kotlin Multiplatform

There is a newer version: 3.1.3-1.1.0

/*
 * Copyright 2022-2023 Jeff Lockhart
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package kotbase

/**
 * IndexBuilder used for building database index objects.
 * Use Database.createIndex(IndexConfiguration, String)
 */
public expect object IndexBuilder {

    /**
     * Create a value index with the given index items. The index items are a list of
     * the properties or expressions to be indexed.
     *
     * @param items The index items
     * @return The value index
     */
    public fun valueIndex(vararg items: ValueIndexItem): ValueIndex

    /**
     * Create a full-text search index with the given index item and options. Typically, the index item is
     * the property that is used to perform the match operation against with.
     *
     * @param items The index items.
     * @return The full-text search index.
     */
    public fun fullTextIndex(vararg items: FullTextIndexItem): FullTextIndex
}