bigframes.pandas.DataFrame.to_markdown#

DataFrame.to_markdown(buf=None,mode:str='wt',index:bool=True,*,allow_large_results:bool|None=None,**kwargs)→str|None[source]#

Print DataFrame in Markdown-friendly format.

Examples:

>>>df=bpd.DataFrame({'col1':[1,2],'col2':[3,4]})>>>print(df.to_markdown())|    |   col1 |   col2 ||---:|-------:|-------:||  0 |      1 |      3 ||  1 |      2 |      4 |
Parameters:

  • buf (str,Path orStringIO-like,optional,default None) – Buffer to write to. If None, the output is returned as a string.

  • mode (str,optional) – Mode in which file is opened.

  • index (bool,optional,default True) – Add index (row) labels.

  • allow_large_results (bool,default None) – If not None, overrides the global setting to allow or disallowlarge query results over the default size limit of 10 GB.

  • **kwargs – These parameters will be passed totabulate.

Returns:

DataFrame in Markdown-friendly format.

Return type:

str