RLMMongoDatabase.h
1.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
////////////////////////////////////////////////////////////////////////////
//
// Copyright 2020 Realm Inc.
//
// 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.
//
////////////////////////////////////////////////////////////////////////////
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
@class RLMMongoCollection;
/// The `RLMMongoDatabase` represents a MongoDB database, which holds a group
/// of collections that contain your data.
///
/// It can be retrieved from the `RLMMongoClient`.
///
/// Use it to get `RLMMongoCollection`s for reading and writing data.
///
/// - Note:
/// Before you can read or write data, a user must log in`.
///
/// - SeeAlso:
/// `RLMMongoClient`, `RLMMongoCollection`
@interface RLMMongoDatabase : NSObject
/// The name of this database
@property (nonatomic, readonly) NSString *name;
/// Gets a collection.
/// @param name The name of the collection to return
/// @returns The collection
- (RLMMongoCollection *)collectionWithName:(NSString *)name;
@end
NS_ASSUME_NONNULL_END