Skip to content

DOC: DataFrame.to_hdf() docstring does not mention data_columns #13061

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
michaelaye opened this issue May 3, 2016 · 1 comment
Closed

DOC: DataFrame.to_hdf() docstring does not mention data_columns #13061

michaelaye opened this issue May 3, 2016 · 1 comment
Labels
Docs IO HDF5 read_hdf, HDFStore
Milestone

Comments

@michaelaye
Copy link
Contributor

Code Sample, a copy-pastable example if possible

To be able to do on-disk filtering per column, one needs to store not only in table format, but also create an index in the HDF file for the columns required to be indexed, or setting it to True, for all columns to be indexed.
This needs to be done by using the method parameter data_columns, which is completely missing from the docstring of to_hdf:

df.to_hdf('teststore.hdf', 'df',format='t', data_columns=True)

Docstring is here

output of pd.show_versions()

INSTALLED VERSIONS

commit: None
python: 3.5.1.final.0
python-bits: 64
OS: Darwin
OS-release: 14.5.0
machine: x86_64
processor: i386
byteorder: little
LC_ALL: None
LANG: en_US.UTF-8

pandas: 0.18.0
nose: None
pip: 8.1.1
setuptools: 20.7.0
Cython: 0.24
numpy: 1.11.0
scipy: 0.17.0
statsmodels: None
xarray: 0.7.1
IPython: 4.2.0
sphinx: 1.4.1
patsy: None
dateutil: 2.5.2
pytz: 2016.3
blosc: None
bottleneck: None
tables: 3.2.2
numexpr: 2.5.2
matplotlib: 1.5.1
openpyxl: None
xlrd: None
xlwt: None
xlsxwriter: None
lxml: None
bs4: None
html5lib: None
httplib2: None
apiclient: None
sqlalchemy: None
pymysql: None
psycopg2: None
jinja2: 2.8
boto: None

@jorisvandenbossche jorisvandenbossche added Docs IO HDF5 read_hdf, HDFStore labels May 3, 2016
@jorisvandenbossche
Copy link
Member

There is a minimal entry in the docstring of HDFStore.append (https://github.com/pydata/pandas/blob/master/pandas/io/pytables.py#L895), but indeed missing in to_hdf. Interested in doing a PR?

@jreback jreback added this to the 0.18.2 milestone May 3, 2016
@jreback jreback modified the milestones: Next Major Release, 0.18.2 Jun 30, 2016
@jreback jreback modified the milestones: 0.19.0, Next Major Release Aug 9, 2016
@jorisvandenbossche jorisvandenbossche modified the milestones: Next Major Release, 0.19.0 Aug 15, 2016
jzwinck added a commit to jzwinck/pandas that referenced this issue Aug 19, 2016
@jreback jreback modified the milestones: 0.19.0, Next Major Release Aug 19, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs IO HDF5 read_hdf, HDFStore
Projects
None yet
3 participants