DOCUMENTATION
/
Language
English
Français
Deutsch
日本語
한국어
Português
Get started
Guides
Developer
Reference
Release notes
Tutorials
Status
For AI agents: documentation index at /llms.txt — fetch to discover all Snowflake documentation pages. Markdown version of this page: /en/developer-guide/snowpark/reference/python/1.55.3/snowpark/api/snowflake.snowpark.DataFrameReader.with_metadata.md
  1. Overview
    • Snowpark Session
      • Snowpark APIs
          1. Input/Output
              1. DataFrameReader
                • DataFrameWriter
                  • FileOperation
                    • PutResult
                      • GetResult
                        • ListResult
                          • DataFrameReader.avro
                            • DataFrameReader.csv
                              • DataFrameReader.dbapi
                                • DataFrameReader.directory
                                  • DataFrameReader.file
                                    • DataFrameReader.format
                                      • DataFrameReader.jdbc
                                        • DataFrameReader.json
                                          • DataFrameReader.load
                                            • DataFrameReader.option
                                              • DataFrameReader.options
                                                • DataFrameReader.orc
                                                  • DataFrameReader.parquet
                                                    • DataFrameReader.schema
                                                      • DataFrameReader.table
                                                        • DataFrameReader.with_metadata
                                                          • DataFrameReader.xml
                                                            • DataFrameWriter.copy_into_location
                                                              • DataFrameWriter.csv
                                                                • DataFrameWriter.format
                                                                  • DataFrameWriter.json
                                                                    • DataFrameWriter.mode
                                                                      • DataFrameWriter.option
                                                                        • DataFrameWriter.options
                                                                          • DataFrameWriter.parquet
                                                                            • DataFrameWriter.save
                                                                              • DataFrameWriter.saveAsTable
                                                                                • DataFrameWriter.save_as_table
                                                                                  • DataFrameWriter.insertInto
                                                                                    • DataFrameWriter.insert_into
                                                                                      • FileOperation.copy_files
                                                                                        • FileOperation.get
                                                                                          • FileOperation.get_stream
                                                                                            • FileOperation.put
                                                                                              • FileOperation.put_stream
                                                                                                • FileOperation.list
                                                                                                  • FileOperation.remove
                                                                                                    • PutResult.count
                                                                                                      • PutResult.index
                                                                                                        • GetResult.count
                                                                                                          • GetResult.index
                                                                                                            • PutResult.message
                                                                                                              • PutResult.source
                                                                                                                • PutResult.source_compression
                                                                                                                  • PutResult.source_size
                                                                                                                    • PutResult.status
                                                                                                                      • PutResult.target
                                                                                                                        • PutResult.target_compression
                                                                                                                          • PutResult.target_size
                                                                                                                            • GetResult.file
                                                                                                                              • GetResult.message
                                                                                                                                • GetResult.size
                                                                                                                                  • GetResult.status
                                                                                                                                    • ListResult.name
                                                                                                                                      • ListResult.size
                                                                                                                                        • ListResult.md5
                                                                                                                                          • ListResult.sha1
                                                                                                                                            • ListResult.last_modified
                                                                                                                                          • DataFrame
                                                                                                                                            • Column
                                                                                                                                              • Data Types
                                                                                                                                                • Row
                                                                                                                                                  • Functions
                                                                                                                                                    • Window
                                                                                                                                                      • Grouping
                                                                                                                                                        • Table Function
                                                                                                                                                          • Table
                                                                                                                                                            • AsyncJob
                                                                                                                                                              • Stored Procedures
                                                                                                                                                                • StoredProcedureProfiler
                                                                                                                                                                  • User-Defined Functions
                                                                                                                                                                    • User-Defined Aggregate Functions
                                                                                                                                                                      • User-Defined Table Functions
                                                                                                                                                                        • Snowpark Secrets
                                                                                                                                                                          • Observability
                                                                                                                                                                            • Files
                                                                                                                                                                              • Catalog
                                                                                                                                                                                • LINEAGE
                                                                                                                                                                                  • Context
                                                                                                                                                                                    • Exceptions
                                                                                                                                                                                      • Testing
                                                                                                                                                                                    • Snowpark pandas API
                                                                                                                                                                                      DeveloperSnowpark APIPythonPython API ReferenceSnowpark APIsInput/OutputDataFrameReader.with_metadata

                                                                                                                                                                                      snowflake.snowpark.DataFrameReader.with_metadata¶

                                                                                                                                                                                      DataFrameReader.with_metadata(*metadata_cols: Iterable[Union[Column, str]]) → DataFrameReader[source]¶

                                                                                                                                                                                      Define the metadata columns that need to be selected from stage files.

                                                                                                                                                                                      Returns:

                                                                                                                                                                                      a DataFrameReader instance with metadata columns to read.

                                                                                                                                                                                      See also

                                                                                                                                                                                      https://docs.snowflake.com/en/user-guide/querying-metadata

                                                                                                                                                                                      Was this page helpful?

                                                                                                                                                                                      Visit Snowflake
                                                                                                                                                                                      Join the conversation
                                                                                                                                                                                      Develop with Snowflake
                                                                                                                                                                                      Share your feedback
                                                                                                                                                                                      Read the latest on our blog
                                                                                                                                                                                      Get your own certification
                                                                                                                                                                                      Privacy NoticeSite TermsCookies Settings© 2026 Snowflake, Inc. All Rights Reserved.