@@ -1191,13 +1191,31 @@ def append_to_multiple(
1191
1191
1192
1192
self .append (k , val , data_columns = dc , ** kwargs )
1193
1193
1194
- def create_table_index (self , key : str , ** kwargs ):
1194
+ def create_table_index (
1195
+ self ,
1196
+ key : str ,
1197
+ columns = None ,
1198
+ optlevel : Optional [int ] = None ,
1199
+ kind : Optional [str ] = None ,
1200
+ ):
1195
1201
"""
1196
1202
Create a pytables index on the table.
1197
1203
1198
1204
Parameters
1199
1205
----------
1200
1206
key : str
1207
+ columns : None, bool, or listlike[str]
1208
+ Indicate which columns to create an index on.
1209
+
1210
+ * False : Do not create any indexes.
1211
+ * True : Create indexes on all columns.
1212
+ * None : Create indexes on all columns.
1213
+ * listlike : Create indexes on the given columns.
1214
+
1215
+ optlevel : int or None, default None
1216
+ Optimization level, if None, pytables defaults to 6.
1217
+ kind : str or None, default None
1218
+ Kind of index, if None, pytables defaults to "medium"
1201
1219
1202
1220
Raises
1203
1221
------
@@ -1212,7 +1230,7 @@ def create_table_index(self, key: str, **kwargs):
1212
1230
1213
1231
if not isinstance (s , Table ):
1214
1232
raise TypeError ("cannot create table index on a Fixed format store" )
1215
- s .create_index (** kwargs )
1233
+ s .create_index (columns = columns , optlevel = optlevel , kind = kind )
1216
1234
1217
1235
def groups (self ):
1218
1236
"""
@@ -3519,18 +3537,26 @@ def f(i, c):
3519
3537
3520
3538
return self ._indexables
3521
3539
3522
- def create_index (self , columns = None , optlevel = None , kind = None ):
3540
+ def create_index (self , columns = None , optlevel = None , kind : Optional [ str ] = None ):
3523
3541
"""
3524
3542
Create a pytables index on the specified columns
3525
3543
note: cannot index Time64Col() or ComplexCol currently;
3526
3544
PyTables must be >= 3.0
3527
3545
3528
3546
Parameters
3529
3547
----------
3530
- columns : False (don't create an index), True (create all columns
3531
- index), None or list_like (the indexers to index)
3532
- optlevel: optimization level (defaults to 6)
3533
- kind : kind of index (defaults to 'medium')
3548
+ columns : None, bool, or listlike[str]
3549
+ Indicate which columns to create an index on.
3550
+
3551
+ * False : Do not create any indexes.
3552
+ * True : Create indexes on all columns.
3553
+ * None : Create indexes on all columns.
3554
+ * listlike : Create indexes on the given columns.
3555
+
3556
+ optlevel : int or None, default None
3557
+ Optimization level, if None, pytables defaults to 6.
3558
+ kind : str or None, default None
3559
+ Kind of index, if None, pytables defaults to "medium"
3534
3560
3535
3561
Raises
3536
3562
------
0 commit comments