summaryrefslogtreecommitdiffstats
path: root/src/arrow/docs/source/python/api/memory.rst
blob: f4382ba23c9e51ff9611f603346a0eda5839cb85 (plain)
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
.. Licensed to the Apache Software Foundation (ASF) under one
.. or more contributor license agreements.  See the NOTICE file
.. distributed with this work for additional information
.. regarding copyright ownership.  The ASF licenses this file
.. to you 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.

.. currentmodule:: pyarrow

.. _api.memory:

Buffers and Memory
==================

In-Memory Buffers
-----------------

Factory Functions
~~~~~~~~~~~~~~~~~

.. autosummary::
   :toctree: ../generated/

   allocate_buffer
   py_buffer
   foreign_buffer

Classes
~~~~~~~

.. autosummary::
   :toctree: ../generated/

   Buffer
   ResizableBuffer

Miscellaneous
~~~~~~~~~~~~~

.. autosummary::
   :toctree: ../generated/

   Codec
   compress
   decompress

.. _api.memory_pool:

Memory Pools
------------

.. autosummary::
   :toctree: ../generated/

   MemoryPool
   default_memory_pool
   jemalloc_memory_pool
   mimalloc_memory_pool
   system_memory_pool
   jemalloc_set_decay_ms
   set_memory_pool
   log_memory_allocations
   total_allocated_bytes