{"Entry":{"collection":"plan","key":"table-function-scan","name":"Table Function Scan","aliases":["T_TableFuncScan","Table Function Scan","TableFuncScan"],"metadata":{"aliases":["T_TableFuncScan","Table Function Scan","TableFuncScan"],"category":"Scan","content_hash":"a07322d149186430843d616369d74d441ac872ce190c0b4bf74feb01c5d55097","derived_content_hash":"66ce1cb4e7f6eddfbf9f01c15d8db38ef1898636f82b3c5ffa7fb2248901b9f3","imported_at":"2026-09-30T00:40:44.260237+08:00","name":"Table Function Scan","name_zh":"TableFuncScan","slug":"table-function-scan","summary":"Scans the rows produced by a table function such as XMLTABLE."}},"Definition":{"Collection":"plan","Key":"table-function-scan","SourceDatabase":"center","Version":"18","SourceTable":"plan_node","SourceKey":"table-function-scan","SourceRevision":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","Facts":{"comparison_data":{"initializer":"ExecInitTableFuncScan","memory_mechanism":"tuplestore","node_tag":"T_TableFuncScan","parallel_callbacks":[],"partial_modes":[],"strategies":[],"text_names":["Table Function Scan"]},"comparison_hash":"3af859883351e2772215a6137da127cf425f1c99d9906aeea3a3761c8d60b4c5","description":["Scans the rows produced by a table function such as XMLTABLE."],"description_zh":"扫描 XMLTABLE 等表函数产生的行。","description_zh_html":"\u003cp\u003e扫描 XMLTABLE 等表函数产生的行。\u003c/p\u003e\u003cp\u003e核心节点标识：\u003ccode\u003eT_TableFuncScan\u003c/code\u003e；EXPLAIN 名称：\u003ccode\u003eTable Function Scan\u003c/code\u003e。\u003c/p\u003e\u003cp\u003e本版本源码中的并行执行或观测回调：该节点实现中未提取到此类回调。回调的存在不表示该节点必然支持共享并行扫描；在并行工作进程中执行也不等于具有并行感知能力。\u003c/p\u003e\u003cp\u003e该节点使用受 \u003ccode\u003ework_mem\u003c/code\u003e 影响的元组存储，必要时可将存储的元组写入临时文件。这并不表示 \u003ccode\u003ework_mem\u003c/code\u003e 限制了该节点的所有内存分配。\u003c/p\u003e\u003ch3\u003e同版本中文手册节选\u003c/h3\u003e\u003cp\u003e\n\u003cspan class=\"productname\"\u003ePostgreSQL\u003c/span\u003e 会为收到的每个查询制定一个\u003cem class=\"firstterm\"\u003e查询计划\u003c/em\u003e。选择与查询结构和数据特性相匹配的正确计划，对获得良好的性能至关重要，因此系统内置了一个复杂的\u003cem class=\"firstterm\"\u003e规划器\u003c/em\u003e来尽量选出好的计划。可以使用 \u003ca class=\"link\" href=\"/zh/docs/18/sql-explain.html\"\u003e\u003ccode class=\"command\"\u003eEXPLAIN\u003c/code\u003e\u003c/a\u003e 命令查看规划器为任意查询生成的查询计划。读懂计划是一门需要经验积累的技能，本节将尝试介绍其中的基础知识。\n   \u003c/p\u003e\u003cp\u003e\n    本节中的示例取自执行过 \u003ccode class=\"command\"\u003eVACUUM ANALYZE\u003c/code\u003e 的回归测试数据库，使用的是 v18 开发版本源码。如果自行尝试这些示例，通常应当能得到相近的结果，但估计代价和行计数可能略有差异，因为 \u003ccode class=\"command\"\u003eANALYZE\u003c/code\u003e 生成的统计信息来自随机采样而非精确计数，而且代价本身在某种程度上也依赖于平台。\n   \u003c/p\u003e\u003cp\u003e\n    这些示例使用 \u003ccode class=\"command\"\u003eEXPLAIN\u003c/code\u003e 默认的\u003cspan class=\"quote\"\u003e“\u003cspan class=\"quote\"\u003etext\u003c/span\u003e”\u003c/span\u003e输出格式，它紧凑且便于人工阅读。如果希望将 \u003ccode class=\"command\"\u003eEXPLAIN\u003c/code\u003e 的输出交给程序做进一步分析，则应改用机器可读的输出格式（XML、JSON 或 YAML）。\n   \u003c/p\u003e\u003cp\u003e\u003ca href=\"/zh/docs/18/using-explain.html\"\u003e查看完整中文手册与上下文\u003c/a\u003e。\u003c/p\u003e\u003cp\u003e本页开头的中文说明为 PG.CENTER 对编辑说明的翻译；手册节选保留对应版本中文文档原文。源码信息及手册示例不代表重新进行过运行测试。\u003c/p\u003e","evidence_kind":"source and documentation","explain_names":["Table Function Scan"],"explain_prefixes":["Parallel","Async"],"facts":[{"label":"Core node tag","value":"T_TableFuncScan"},{"label":"Structured EXPLAIN Node Type","value":"Table Function Scan"},{"label":"Inputs","value":"A table-function expression"},{"label":"Output","value":"Table-function result tuples"},{"label":"Executor initializer","value":"ExecInitTableFuncScan"},{"label":"Memory mechanism","value":"tuplestore"}],"facts_zh":[{"label":"核心节点标签","value":"T_TableFuncScan"},{"label":"结构化 EXPLAIN 节点类型","value":"Table Function Scan"},{"label":"输入","value":"表函数表达式"},{"label":"输出","value":"表函数结果元组"},{"label":"执行器初始化函数","value":"ExecInitTableFuncScan"},{"label":"内存机制","value":"tuplestore"}],"memory":{"description":"This node creates a tuplestore with work_mem. The tuplestore can move stored tuples to temporary files; this does not make work_mem a cap on every allocation made by the node.","evidence":[{"archive_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","label":"src/backend/executor/nodeTableFuncscan.c","path":"src/backend/executor/nodeTableFuncscan.c","sha256":"0a9faaa9e45bb460dd98e4688f088711d459333eb8bd94255779f2c0218df82b","url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2"},{"archive_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","label":"src/backend/utils/sort/tuplestore.c","path":"src/backend/utils/sort/tuplestore.c","sha256":"27a85416bafed557006c705ab5d0c5dce3d3c1702812bb54d136f2ac4c41055a","url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2"}],"mechanism":"tuplestore","source_notes":[]},"node_tag":"T_TableFuncScan","parallel_callbacks":[],"partial_modes":[],"related":[{"label":"EXPLAIN","url":"/wiki/sql/explain/?v=18"},{"label":"Using EXPLAIN","url":"/docs/18/using-explain.html"},{"label":"Parallel plans","url":"/docs/18/parallel-plans.html"},{"label":"work_mem","url":"/wiki/guc/work_mem/?v=18"}],"release":{"channel":"stable","label":"18.6","major":"18","ref":"PostgreSQL 18.6 source archive","revision":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","source_snapshot_utc":"","source_url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2"},"runtime_verified":false,"sections":[{"paragraphs":["Structured formats use the Node Type above. Text-format spellings can also include operation, strategy, join type, scan direction or aggregation-stage attributes.","Text names recorded by this source: Table Function Scan.","Parallel-aware and parallel-safe are different plan properties. A node running inside a parallel worker is not necessarily a parallel-aware node."],"title":"EXPLAIN names and attributes"},{"paragraphs":["This node creates a tuplestore with work_mem. The tuplestore can move stored tuples to temporary files; this does not make work_mem a cap on every allocation made by the node."],"title":"Memory and temporary storage"},{"paragraphs":["The source callbacks below can coordinate execution or collect worker instrumentation. Their presence is not a blanket claim that this node supports a shared parallel scan or shared state.","Callbacks in this build: none extracted from this node implementation."],"title":"Parallel execution and instrumentation"},{"paragraphs":["nodeTableFuncscan.c Support routines for scanning RangeTableFunc (XMLTABLE like functions).","If first time through, read all tuples from function and put them in a tuplestore. Subsequent calls just fetch tuples from tuplestore.","TableFuncRecheck -- access method routine to recheck a tuple in EvalPlanQual","Scans the function sequentially and returns the next qualifying tuple. We call the ExecScan() routine and pass it the appropriate access method functions.","Each call to fetch a new set of rows - of which there may be very many if XMLTABLE or JSON_TABLE is being used in a lateral join - will allocate a possibly substantial amount of memory, so we cannot use the per-query context here. perTableCxt now serves the same function as \"argcontext\" does in FunctionScan - a place to store per-one-call (i.e. one result table) lifetime data (as opposed to per-query or per-result-tuple)."],"title":"Executor implementation notes"},{"code":"case T_TableFuncScan:\n\t\t\tpname = sname = \"Table Function Scan\";\n\t\t\tbreak;","title":"EXPLAIN identity in core source"}],"sections_zh":[{"paragraphs":["结构化格式使用上述 Node Type。文本格式名称还可能包含操作、策略、连接类型、扫描方向或聚合阶段属性。","此源码记录的文本名称：Table Function Scan.","并行感知与并行安全是不同的计划属性。在并行工作进程内运行的节点不一定是并行感知节点。"],"title":"EXPLAIN 名称与属性"},{"paragraphs":["此节点使用 work_mem 创建 tuplestore。tuplestore 可以将存储的元组移到临时文件，但这不意味着 work_mem 限制了节点的全部内存分配。"],"title":"内存与临时存储"},{"paragraphs":["以下源码回调可以协调执行或收集工作进程的测量数据。回调存在不代表该节点普遍支持共享并行扫描或共享状态。","此构建的回调：none extracted from this node implementation."],"title":"并行执行与运行信息采集"},{"paragraphs":["nodeTableFuncscan.c：支持扫描 RangeTableFunc（类似 XMLTABLE 的函数）的例程。","首次执行时，从函数读取全部元组并存入 tuplestore；后续调用只需从 tuplestore 获取元组。","TableFuncRecheck：在 EvalPlanQual 中重新检查元组的访问方法例程。","顺序扫描函数并返回下一个满足条件的元组。调用 ExecScan() 并传入相应的访问方法函数。","每次调用获取一组新行都可能分配大量内存；当 XMLTABLE 或 JSON_TABLE 用于横向连接时，此类调用可能很多，因此这里不能使用查询级内存上下文。perTableCxt 现在承担与 FunctionScan 中“argcontext”相同的作用，用于存储生命周期限定为一次调用（即一个结果表）的数据，而非整个查询或单个结果元组的数据。"],"title":"执行器实现说明"},{"code":"case T_TableFuncScan:\n\t\t\tpname = sname = \"Table Function Scan\";\n\t\t\tbreak;","title":"核心源码中的 EXPLAIN 标识"}],"source_inventory":{"executor":"src/backend/executor/execProcnode.c","explain":"src/backend/commands/explain.c","implementation":"src/backend/executor/nodeTableFuncscan.c"},"sources":[{"archive_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","label":"src/backend/commands/explain.c:1468","line":1468,"path":"src/backend/commands/explain.c","sha256":"34c86d6070224a0e981efef51f79101d6d505e5874f1684ace183034bab14bb4","url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2"},{"archive_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","label":"src/backend/executor/execProcnode.c:259","line":259,"path":"src/backend/executor/execProcnode.c","sha256":"f8a06a3f539077249b20664b2812433db6d7bd12b2c0ca633525db43d06f112a","url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2"},{"archive_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","label":"src/backend/executor/nodeTableFuncscan.c","path":"src/backend/executor/nodeTableFuncscan.c","sha256":"0a9faaa9e45bb460dd98e4688f088711d459333eb8bd94255779f2c0218df82b","url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2"},{"archive_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","label":"src/include/nodes/plannodes.h","path":"src/include/nodes/plannodes.h","sha256":"52422b327a8049fbbb20d8b96008a0fc0a6fafa60f7eff3c695d5b2e83830120","url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2"},{"archive_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","label":"src/backend/utils/sort/tuplestore.c","path":"src/backend/utils/sort/tuplestore.c","sha256":"27a85416bafed557006c705ab5d0c5dce3d3c1702812bb54d136f2ac4c41055a","url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2"}],"strategies":[],"tables":[{"columns":[{"key":"label","label":"Text-format label"},{"key":"identity","label":"Structured node identity"}],"key":"explain-labels","rows":[{"identity":"Table Function Scan","label":"Table Function Scan"}],"title":"EXPLAIN labels in this source build"}],"tables_zh":[{"columns":[{"key":"label","label":"文本格式标签"},{"key":"identity","label":"结构化节点标识"}],"key":"explain-labels","rows":[{"identity":"Table Function Scan","label":"Table Function Scan"}],"title":"本构建中的 EXPLAIN 标签"}],"zh_from":{"authored_translation":"authored-translation-of-reviewed-guidance","body_sha256":"59b78325ecb10cb2f2bfffbd5a088ec5526a10e4b26b6ed4c5119adf6bdd179e","kind":"same-version-chinese-manual-with-authored-translation-of-reviewed-guidance","manual":{"anchor":"","build_id":107,"extraction":"concept-introduction","fragment_sha256":"15fbdf84b8f499253ade4f4a5841de138619a9933b93cc241d431dbe922fa40c","locale":"zh-Hans","page_key":"using-explain.html","source_hash":"d2f749744b3ac5aa2eb0154f295e8163903cd20fcc130c74c6172cdf2ae3a9df","source_revision":"unknown:rendered-translation-baseline","translated_from_revision":null,"translation_revision":"git:b1b500221dbe5437cfca004d6b04d3f6e422765d;html-sha256:08e987a66af27b98444a8057c256314eafa13611a3fb9e888214fc436824244b","url":"/zh/docs/18/using-explain.html","version":"18"},"runtime_rerun":false,"source_facts_revision":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"}},"ManualEvidence":{"release":{"channel":"stable","label":"18.6","major":"18","ref":"PostgreSQL 18.6 source archive","revision":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","source_snapshot_utc":"","source_url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2"},"sources":[{"archive_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","label":"src/backend/commands/explain.c:1468","line":1468,"path":"src/backend/commands/explain.c","sha256":"34c86d6070224a0e981efef51f79101d6d505e5874f1684ace183034bab14bb4","url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2"},{"archive_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","label":"src/backend/executor/execProcnode.c:259","line":259,"path":"src/backend/executor/execProcnode.c","sha256":"f8a06a3f539077249b20664b2812433db6d7bd12b2c0ca633525db43d06f112a","url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2"},{"archive_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","label":"src/backend/executor/nodeTableFuncscan.c","path":"src/backend/executor/nodeTableFuncscan.c","sha256":"0a9faaa9e45bb460dd98e4688f088711d459333eb8bd94255779f2c0218df82b","url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2"},{"archive_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","label":"src/include/nodes/plannodes.h","path":"src/include/nodes/plannodes.h","sha256":"52422b327a8049fbbb20d8b96008a0fc0a6fafa60f7eff3c695d5b2e83830120","url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2"},{"archive_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","label":"src/backend/utils/sort/tuplestore.c","path":"src/backend/utils/sort/tuplestore.c","sha256":"27a85416bafed557006c705ab5d0c5dce3d3c1702812bb54d136f2ac4c41055a","url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2"}]},"MeasuredEvidence":{"runtime_verified":false}},"Text":{"Collection":"plan","Key":"table-function-scan","SourceDatabase":"center","Version":"18","Locale":"en","Title":"Table Function Scan","Summary":"Scans the rows produced by a table function such as XMLTABLE.","BodyHTML":"\u003cp\u003eScans the rows produced by a table function such as XMLTABLE.\u003c/p\u003e","SourceRevision":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","ContentHash":"2302f2edfe58bca1efa321fc0c798b2bb87741b156835e32926252c6af02b401","Payload":{"description":["Scans the rows produced by a table function such as XMLTABLE."],"related":[{"label":"EXPLAIN","url":"/wiki/sql/explain/?v=18"},{"label":"Using EXPLAIN","url":"/docs/18/using-explain.html"},{"label":"Parallel plans","url":"/docs/18/parallel-plans.html"},{"label":"work_mem","url":"/wiki/guc/work_mem/?v=18"}],"sections":[{"paragraphs":["Structured formats use the Node Type above. Text-format spellings can also include operation, strategy, join type, scan direction or aggregation-stage attributes.","Text names recorded by this source: Table Function Scan.","Parallel-aware and parallel-safe are different plan properties. A node running inside a parallel worker is not necessarily a parallel-aware node."],"title":"EXPLAIN names and attributes"},{"paragraphs":["This node creates a tuplestore with work_mem. The tuplestore can move stored tuples to temporary files; this does not make work_mem a cap on every allocation made by the node."],"title":"Memory and temporary storage"},{"paragraphs":["The source callbacks below can coordinate execution or collect worker instrumentation. Their presence is not a blanket claim that this node supports a shared parallel scan or shared state.","Callbacks in this build: none extracted from this node implementation."],"title":"Parallel execution and instrumentation"},{"paragraphs":["nodeTableFuncscan.c Support routines for scanning RangeTableFunc (XMLTABLE like functions).","If first time through, read all tuples from function and put them in a tuplestore. Subsequent calls just fetch tuples from tuplestore.","TableFuncRecheck -- access method routine to recheck a tuple in EvalPlanQual","Scans the function sequentially and returns the next qualifying tuple. We call the ExecScan() routine and pass it the appropriate access method functions.","Each call to fetch a new set of rows - of which there may be very many if XMLTABLE or JSON_TABLE is being used in a lateral join - will allocate a possibly substantial amount of memory, so we cannot use the per-query context here. perTableCxt now serves the same function as \"argcontext\" does in FunctionScan - a place to store per-one-call (i.e. one result table) lifetime data (as opposed to per-query or per-result-tuple)."],"title":"Executor implementation notes"},{"code":"case T_TableFuncScan:\n\t\t\tpname = sname = \"Table Function Scan\";\n\t\t\tbreak;","title":"EXPLAIN identity in core source"}],"tables":[{"columns":[{"key":"label","label":"Text-format label"},{"key":"identity","label":"Structured node identity"}],"key":"explain-labels","rows":[{"identity":"Table Function Scan","label":"Table Function Scan"}],"title":"EXPLAIN labels in this source build"}]}},"RequestedLocale":"en","Fallback":false,"Versions":["10","11","12","13","14","15","16","17","18","19","20"],"Locales":["en","zh-Hans"],"Signatures":null,"Spellings":null,"SQLState":null,"Evidence":null}
