QueryIndex.hh

Go to the documentation of this file.

//
// QueryIndex.hh
//
// Copyright (c) 2024 Couchbase, Inc All rights reserved.
//
// 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.
//
 
 
#pragma once
#include "cbl++/Base.hh"
#include "cbl++/Collection.hh"
#include "cbl/CBLQueryIndex.h"
 
CBL_ASSUME_NONNULL_BEGIN
 
namespace cbl {
#ifdef COUCHBASE_ENTERPRISE
    class IndexUpdater;
#endif

    class QueryIndex : private RefCounted {
    public:
        // Accessors:
        
        std::string name() const                        {return internal::asString(CBLQueryIndex_Name(ref()));}
        
        Collection collection() const                   {return Collection(CBLQueryIndex_Collection(ref()));}
        
#ifdef COUCHBASE_ENTERPRISE
        // Index Updater:
        
        inline IndexUpdater beginUpdate(size_t limit);
#endif
        
    protected:
        friend class Collection;
        
        static QueryIndex adopt(const CBLQueryIndex* _cbl_nullable i, CBLError *error) {
            if (!i && error->code != 0)
                internal::check(false, *error);
            QueryIndex index;
            index._ref = (CBLRefCounted*)i;
            return index;
        }
        
        CBL_REFCOUNTED_BOILERPLATE(QueryIndex, RefCounted, CBLQueryIndex)
    };
 
#ifdef COUCHBASE_ENTERPRISE

    class IndexUpdater : private RefCounted {
    public:
        size_t count() const                            {return CBLIndexUpdater_Count(ref());}
        
        fleece::Value value(size_t index) const {
            return CBLIndexUpdater_Value(ref(), index);
        }
        
        void setVector(unsigned index, const float* _cbl_nullable vector, size_t dimension) {
            CBLError error;
            internal::check(CBLIndexUpdater_SetVector(ref(), index, vector, dimension, &error), error);
        }
        
        void skipVector(size_t index) {
            CBLIndexUpdater_SkipVector(ref(), index);
        }
        
        void finish() {
            CBLError error;
            internal::check(CBLIndexUpdater_Finish(ref(), &error), error);
        }
        
    protected:
        static IndexUpdater adopt(const CBLIndexUpdater* _cbl_nullable i, CBLError *error) {
            internal::check(i != nullptr || error->code == 0, *error);
            IndexUpdater updater;
            updater._ref = (CBLRefCounted*)i;
            return updater;
        }
        
        friend class QueryIndex;
        CBL_REFCOUNTED_BOILERPLATE(IndexUpdater, RefCounted, CBLIndexUpdater)
    };
 
    IndexUpdater QueryIndex::beginUpdate(size_t limit) {
        CBLError error {};
        auto updater = CBLQueryIndex_BeginUpdate(ref(), limit, &error);
        return IndexUpdater::adopt(updater, &error);
    }
#endif
 
    QueryIndex Collection::getIndex(std::string_view name) {
        CBLError error {};
        return QueryIndex::adopt(CBLCollection_GetIndex(ref(), slice(name), &error), &error);
    }
}
 
CBL_ASSUME_NONNULL_END