CBLQueryIndex.h

Go to the documentation of this file.

//
//  CBLQueryIndex.h
//
// 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 "CBLBase.h"
#include "CBLQueryTypes.h"
 
CBL_CAPI_BEGIN
 
CBL_REFCOUNTED(CBLQueryIndex*, QueryIndex);
 
FLString CBLQueryIndex_Name(const CBLQueryIndex* index) CBLAPI;
 
CBLCollection* CBLQueryIndex_Collection(const CBLQueryIndex* index) CBLAPI;
 
#ifdef COUCHBASE_ENTERPRISE
 
CBL_REFCOUNTED(CBLIndexUpdater*, IndexUpdater);
 
_cbl_warn_unused
CBLIndexUpdater* _cbl_nullable CBLQueryIndex_BeginUpdate(CBLQueryIndex* index,
                                                    size_t limit,
                                                    CBLError* _cbl_nullable outError) CBLAPI;
 
size_t CBLIndexUpdater_Count(const CBLIndexUpdater* updater) CBLAPI;
 
FLValue CBLIndexUpdater_Value(CBLIndexUpdater* updater, size_t index) CBLAPI;
 
bool CBLIndexUpdater_SetVector(CBLIndexUpdater* updater,
                               size_t index,
                               const float vector[_cbl_nullable],
                               size_t dimension,
                               CBLError* _cbl_nullable outError) CBLAPI;
 
void CBLIndexUpdater_SkipVector(CBLIndexUpdater* updater, size_t index) CBLAPI;
 
bool CBLIndexUpdater_Finish(CBLIndexUpdater* updater, CBLError* _cbl_nullable outError) CBLAPI;
 
#endif
 
CBL_CAPI_END