Couchbase Lite C
Couchbase Lite C API
CBLScope.h
Go to the documentation of this file.
1//
2// CBLScope.h
3//
4// Copyright (c) 2022 Couchbase, Inc All rights reserved.
5//
6// Licensed under the Apache License, Version 2.0 (the "License");
7// you may not use this file except in compliance with the License.
8// You may obtain a copy of the License at
9//
10// http://www.apache.org/licenses/LICENSE-2.0
11//
12// Unless required by applicable law or agreed to in writing, software
13// distributed under the License is distributed on an "AS IS" BASIS,
14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15// See the License for the specific language governing permissions and
16// limitations under the License.
17//
18
19#pragma once
20#include "CBLBase.h"
21
23
40
48
60
66
80 CBLError* _cbl_nullable outError) CBLAPI;
81
89 FLString collectionName,
90 CBLError* _cbl_nullable outError) CBLAPI;
91 // end of outer \defgroup
94
#define CBLAPI
Definition: CBL_Compat.h:104
#define _cbl_nullable
Definition: CBL_Compat.h:92
#define CBL_CAPI_BEGIN
Definition: CBL_Compat.h:105
#define CBL_CAPI_END
Definition: CBL_Compat.h:106
#define CBL_PUBLIC
Definition: CBL_Compat.h:123
struct CBLCollection CBLCollection
A collection, a document container.
Definition: CBLBase.h:194
struct CBLDatabase CBLDatabase
A connection to an open database.
Definition: CBLBase.h:182
#define CBL_REFCOUNTED(TYPE, NAME)
Definition: CBLBase.h:170
FLString CBLScope_Name(const CBLScope *scope)
Returns the name of the scope.
CBL_PUBLIC const FLString kCBLDefaultScopeName
The default scope's name.
CBLDatabase * CBLScope_Database(const CBLScope *scope)
Returns the scope's database.
struct CBLScope CBLScope
A collection's scope.
Definition: CBLBase.h:188
CBLCollection *_cbl_nullable CBLScope_Collection(const CBLScope *scope, FLString collectionName, CBLError *_cbl_nullable outError)
Returns an existing collection in the scope with the given name.
FLMutableArray _cbl_nullable CBLScope_CollectionNames(const CBLScope *scope, CBLError *_cbl_nullable outError)
Returns the names of all collections in the scope.
struct _FLArray * FLMutableArray
A reference to a mutable array.
Definition: FLBase.h:39
A struct holding information about an error.
Definition: CBLBase.h:104
A simple reference to a block of memory.
Definition: FLSlice.h:45