CBLQuery.h

Go to the documentation of this file.

//
// CBLQuery.h
//
// Copyright (c) 2018 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 "fleece/Fleece.h"
 
CBL_CAPI_BEGIN
 
 
typedef CBL_ENUM(uint32_t, CBLQueryLanguage) {
    kCBLJSONLanguage,       
    kCBLN1QLLanguage        
};
 
 
_cbl_warn_unused
CBLQuery* _cbl_nullable CBLDatabase_CreateQuery(const CBLDatabase* db,
                                                CBLQueryLanguage language,
                                                FLString queryString,
                                                int* _cbl_nullable outErrorPos,
                                                CBLError* _cbl_nullable outError) CBLAPI;
 
CBL_REFCOUNTED(CBLQuery*, Query);
 
void CBLQuery_SetParameters(CBLQuery* query,
                            FLDict parameters) CBLAPI;
 
FLDict _cbl_nullable CBLQuery_Parameters(const CBLQuery* query) CBLAPI;
 
_cbl_warn_unused
CBLResultSet* _cbl_nullable CBLQuery_Execute(CBLQuery*,
                                             CBLError* _cbl_nullable outError) CBLAPI;
 
_cbl_warn_unused
FLSliceResult CBLQuery_Explain(const CBLQuery*) CBLAPI;
 
unsigned CBLQuery_ColumnCount(const CBLQuery*) CBLAPI;
 
FLSlice CBLQuery_ColumnName(const CBLQuery*,
                            unsigned columnIndex) CBLAPI;
 
_cbl_warn_unused
bool CBLResultSet_Next(CBLResultSet*) CBLAPI;
 
FLValue CBLResultSet_ValueAtIndex(const CBLResultSet*,
                                  unsigned index) CBLAPI;
 
FLValue CBLResultSet_ValueForKey(const CBLResultSet*,
                                 FLString key) CBLAPI;
 
FLArray CBLResultSet_ResultArray(const CBLResultSet*) CBLAPI;
 
FLDict CBLResultSet_ResultDict(const CBLResultSet*) CBLAPI;
 
CBLQuery* CBLResultSet_GetQuery(const CBLResultSet *rs) CBLAPI;
 
CBL_REFCOUNTED(CBLResultSet*, ResultSet);
 
typedef void (*CBLQueryChangeListener)(void* _cbl_nullable context,
                                       CBLQuery* query,
                                       CBLListenerToken* token);
 
_cbl_warn_unused
CBLListenerToken* CBLQuery_AddChangeListener(CBLQuery* query,
                                             CBLQueryChangeListener listener,
                                             void* _cbl_nullable context) CBLAPI;
 
_cbl_warn_unused
CBLResultSet* _cbl_nullable CBLQuery_CopyCurrentResults(const CBLQuery* query,
                                                        CBLListenerToken *listener,
                                                        CBLError* _cbl_nullable outError) CBLAPI;
 
typedef struct {
    CBLQueryLanguage expressionLanguage;
    
    FLString expressions;
} CBLValueIndexConfiguration;
 
bool CBLDatabase_CreateValueIndex(CBLDatabase *db,
                                  FLString name,
                                  CBLValueIndexConfiguration config,
                                  CBLError* _cbl_nullable outError) CBLAPI;
 
 
typedef struct {
    CBLQueryLanguage expressionLanguage;
    
    FLString expressions;
    
    bool ignoreAccents;
    
    FLString language;
} CBLFullTextIndexConfiguration;
 
bool CBLDatabase_CreateFullTextIndex(CBLDatabase *db,
                                     FLString name,
                                     CBLFullTextIndexConfiguration config,
                                     CBLError* _cbl_nullable outError) CBLAPI;
 
bool CBLDatabase_DeleteIndex(CBLDatabase *db,
                             FLString name,
                             CBLError* _cbl_nullable outError) CBLAPI;
 
_cbl_warn_unused
FLArray CBLDatabase_GetIndexNames(CBLDatabase *db) CBLAPI;
 
CBL_CAPI_END