File tree Expand file tree Collapse file tree 12 files changed +131
-276
lines changed
Expand file tree Collapse file tree 12 files changed +131
-276
lines changed Original file line number Diff line number Diff line change 1- (api_arrow)=
1+ .. _ api_arrow :
22
3- # Apache Arrow Integration
3+ Apache Arrow Integration
4+ ========================
45
56This section covers Apache Arrow-specific cursors, result sets, and data converters.
67
7- ## Arrow Cursors
8+ Arrow Cursors
9+ -------------
810
9- ``` {eval-rst}
1011.. autoclass :: pyathena.arrow.cursor.ArrowCursor
1112 :members:
1213 :inherited-members:
13- ```
1414
15- ``` {eval-rst}
1615.. autoclass :: pyathena.arrow.async_cursor.AsyncArrowCursor
1716 :members:
1817 :inherited-members:
19- ```
2018
21- ## Arrow Result Set
19+ Arrow Result Set
20+ ----------------
2221
23- ``` {eval-rst}
2422.. autoclass :: pyathena.arrow.result_set.AthenaArrowResultSet
2523 :members:
2624 :inherited-members:
27- ```
2825
29- ## Arrow Data Converters
26+ Arrow Data Converters
27+ ----------------------
3028
31- ``` {eval-rst}
3229.. autoclass :: pyathena.arrow.converter.DefaultArrowTypeConverter
3330 :members:
34- ```
3531
36- ``` {eval-rst}
3732.. autoclass :: pyathena.arrow.converter.DefaultArrowUnloadTypeConverter
3833 :members:
39- ```
4034
41- ## Arrow Utilities
35+ Arrow Utilities
36+ ---------------
4237
43- ``` {eval-rst}
4438.. autofunction :: pyathena.arrow.util.to_column_info
45- ```
4639
47- ``` {eval-rst}
48- .. autofunction:: pyathena.arrow.util.get_athena_type
49- ```
40+ .. autofunction :: pyathena.arrow.util.get_athena_type
Original file line number Diff line number Diff line change 1- (api_connection)=
1+ .. _ api_connection :
22
3- # Connection and Cursors
3+ Connection and Cursors
4+ ======================
45
56This section covers the core connection functionality and basic cursor operations.
67
7- ## Connection
8+ Connection
9+ ----------
810
9- ``` {eval-rst}
1011.. automodule :: pyathena
1112 :members: connect
12- ```
1313
14- ``` {eval-rst}
1514.. autoclass :: pyathena.connection.Connection
1615 :members:
1716 :inherited-members:
18- ```
1917
20- ## Standard Cursors
18+ Standard Cursors
19+ ----------------
2120
22- ``` {eval-rst}
2321.. autoclass :: pyathena.cursor.Cursor
2422 :members:
2523 :inherited-members:
26- ```
2724
28- ``` {eval-rst}
2925.. autoclass :: pyathena.cursor.DictCursor
3026 :members:
3127 :inherited-members:
32- ```
3328
34- ## Asynchronous Cursors
29+ Asynchronous Cursors
30+ --------------------
3531
36- ``` {eval-rst}
3732.. autoclass :: pyathena.async_cursor.AsyncCursor
3833 :members:
3934 :inherited-members:
40- ```
4135
42- ``` {eval-rst}
4336.. autoclass :: pyathena.async_cursor.AsyncDictCursor
4437 :members:
4538 :inherited-members:
46- ```
4739
48- ## Result Sets
40+ Result Sets
41+ -----------
4942
50- ``` {eval-rst}
5143.. autoclass :: pyathena.result_set.AthenaResultSet
5244 :members:
5345 :inherited-members:
54- ```
5546
56- ``` {eval-rst}
5747.. autoclass :: pyathena.result_set.AthenaDictResultSet
5848 :members:
5949 :inherited-members:
60- ```
6150
62- ``` {eval-rst}
6351.. autoclass :: pyathena.result_set.WithResultSet
64- :members:
65- ```
52+ :members:
Original file line number Diff line number Diff line change 1- (api_converters)=
1+ .. _ api_converters :
22
3- # Data Conversion
3+ Data Conversion
4+ ===============
45
56This section covers data type converters and parameter formatters.
67
7- ## Type Converters
8+ Type Converters
9+ ---------------
810
9- ``` {eval-rst}
1011.. autoclass :: pyathena.converter.Converter
1112 :members:
12- ```
1313
14- ``` {eval-rst}
1514.. autoclass :: pyathena.converter.DefaultTypeConverter
1615 :members:
17- ```
1816
19- ## Parameter Formatters
17+ Parameter Formatters
18+ --------------------
2019
21- ``` {eval-rst}
2220.. autoclass :: pyathena.formatter.Formatter
2321 :members:
24- ```
2522
26- ``` {eval-rst}
2723.. autoclass :: pyathena.formatter.DefaultParameterFormatter
28- :members:
29- ```
24+ :members:
Original file line number Diff line number Diff line change 1- (api_errors)=
1+ .. _ api_errors :
22
3- # Exception Handling
3+ Exception Handling
4+ ==================
45
56This section covers all PyAthena exception classes and error handling.
67
7- ## Exception Hierarchy
8+ Exception Hierarchy
9+ --------------------
810
9- ``` {eval-rst}
1011.. automodule :: pyathena.error
1112 :members:
1213 :show-inheritance:
13- ```
1414
15- ## Base Exceptions
15+ Base Exceptions
16+ ---------------
1617
17- ``` {eval-rst}
1818.. autoclass :: pyathena.error.Error
1919 :members:
20- ```
2120
22- ``` {eval-rst}
2321.. autoclass :: pyathena.error.Warning
2422 :members:
25- ```
2623
27- ## Interface Errors
24+ Interface Errors
25+ -----------------
2826
29- ``` {eval-rst}
3027.. autoclass :: pyathena.error.InterfaceError
3128 :members:
32- ```
3329
34- ``` {eval-rst}
3530.. autoclass :: pyathena.error.DatabaseError
3631 :members:
37- ```
3832
39- ## Data Errors
33+ Data Errors
34+ -----------
4035
41- ``` {eval-rst}
4236.. autoclass :: pyathena.error.DataError
4337 :members:
44- ```
4538
46- ``` {eval-rst}
4739.. autoclass :: pyathena.error.IntegrityError
4840 :members:
49- ```
5041
51- ``` {eval-rst}
5242.. autoclass :: pyathena.error.InternalError
5343 :members:
54- ```
5544
56- ## Operational Errors
45+ Operational Errors
46+ ------------------
5747
58- ``` {eval-rst}
5948.. autoclass :: pyathena.error.OperationalError
6049 :members:
61- ```
6250
63- ``` {eval-rst}
6451.. autoclass :: pyathena.error.ProgrammingError
6552 :members:
66- ```
6753
68- ``` {eval-rst}
6954.. autoclass :: pyathena.error.NotSupportedError
70- :members:
71- ```
55+ :members:
Original file line number Diff line number Diff line change 1- (api_filesystem)=
1+ .. _ api_filesystem :
22
3- # File System Integration
3+ File System Integration
4+ =======================
45
56This section covers S3 filesystem integration and object management.
67
7- ## S3 FileSystem
8+ S3 FileSystem
9+ -------------
810
9- ``` {eval-rst}
1011.. autoclass :: pyathena.filesystem.s3.S3FileSystem
1112 :members:
12- ```
1313
14- ``` {eval-rst}
1514.. autoclass :: pyathena.filesystem.s3.S3File
1615 :members:
17- ```
1816
19- ## S3 Objects
17+ S3 Objects
18+ ----------
2019
21- ``` {eval-rst}
2220.. autoclass :: pyathena.filesystem.s3_object.S3Object
2321 :members:
24- ```
2522
26- ``` {eval-rst}
2723.. autoclass :: pyathena.filesystem.s3_object.S3ObjectType
2824 :members:
29- ```
3025
31- ``` {eval-rst}
3226.. autoclass :: pyathena.filesystem.s3_object.S3StorageClass
3327 :members:
34- ```
3528
36- ## S3 Upload Operations
29+ S3 Upload Operations
30+ --------------------
3731
38- ``` {eval-rst}
3932.. autoclass :: pyathena.filesystem.s3_object.S3PutObject
4033 :members:
41- ```
4234
43- ``` {eval-rst}
4435.. autoclass :: pyathena.filesystem.s3_object.S3MultipartUpload
4536 :members:
46- ```
4737
48- ``` {eval-rst}
4938.. autoclass :: pyathena.filesystem.s3_object.S3MultipartUploadPart
5039 :members:
51- ```
5240
53- ``` {eval-rst}
5441.. autoclass :: pyathena.filesystem.s3_object.S3CompleteMultipartUpload
55- :members:
56- ```
42+ :members:
You can’t perform that action at this time.
0 commit comments