/
cat.txt
59 lines (37 loc) · 1.18 KB
/
cat.txt
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
50
51
52
53
54
55
56
57
58
59
=====
cat()
=====
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. method:: cat(filename,useBinaryMode)
Returns the contents of the specified file. The method returns with
output relative to the current shell session and does not impact the
server.
.. list-table::
:header-rows: 1
:widths: 20 20 80
* - Parameter
- Type
- Description
* - ``filename``
- string
- The filepath to open. The filepath must be on the local file system.
* - ``useBinaryMode``
- boolean
- *Optional.* Flag to determine whether to open
file in binary mode or text mode.
*Applicable for Windows.*
- Specify ``true`` to open the file in binary mode.
On Windows, opening the file in binary mode leaves the
character '\\n' as is.
- Specify ``false`` to open the file in text mode.
On Windows, opening the file in text mode converts the
character '\\n' to '\\r\\n'.
The default value is ``false``.
.. versionadded:: 4.0.5