c4Query.h

Go to the documentation of this file.

//
// c4Query.h
//
// Copyright 2016-Present Couchbase, Inc.
//
// Use of this software is governed by the Business Source License included
// in the file licenses/BSL-Couchbase.txt.  As of the Change Date specified
// in that file, in accordance with the Business Source License, use of this
// software will be governed by the Apache License, Version 2.0, included in
// the file licenses/APL2.txt.
//
 
#pragma once
#include "c4QueryTypes.h"
 
C4_ASSUME_NONNULL_BEGIN
C4API_BEGIN_DECLS
 
 
 
NODISCARD CBL_CORE_API C4Query* C4NULLABLE c4query_new2(C4Database* database, C4QueryLanguage language,
                                                        C4String expression, int* C4NULLABLE outErrorPos,
                                                        C4Error* C4NULLABLE error) C4API;
 
CBL_CORE_API C4StringResult c4query_explain(C4Query*) C4API;
 
 
CBL_CORE_API unsigned c4query_columnCount(C4Query*) C4API;
 
CBL_CORE_API FLString c4query_columnTitle(C4Query*, unsigned column) C4API;
 
 
 
 
CBL_CORE_API void c4query_setParameters(C4Query* query, C4String encodedParameters) C4API;
 
 
NODISCARD CBL_CORE_API C4QueryEnumerator* C4NULLABLE c4query_run(C4Query* query, C4String encodedParameters,
                                                                 C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API C4StringResult c4query_fullTextMatched(C4Query* query, const C4FullTextMatch* term,
                                                    C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API bool c4queryenum_next(C4QueryEnumerator* e, C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API int64_t c4queryenum_getRowCount(C4QueryEnumerator* e, C4Error* C4NULLABLE outError) C4API;
 
NODISCARD CBL_CORE_API bool c4queryenum_seek(C4QueryEnumerator* e, int64_t rowIndex,
                                             C4Error* C4NULLABLE outError) C4API;
 
NODISCARD static inline bool c4queryenum_restart(C4QueryEnumerator* e, C4Error* C4NULLABLE outError) C4API {
    return c4queryenum_seek(e, -1, outError);
}
 
NODISCARD CBL_CORE_API C4QueryEnumerator* C4NULLABLE c4queryenum_refresh(C4QueryEnumerator*  e,
                                                                         C4Error* C4NULLABLE outError) C4API;
 
CBL_CORE_API void c4queryenum_close(C4QueryEnumerator*) C4API;
 
C4API_END_DECLS
C4_ASSUME_NONNULL_END