website-sqlnotebook.com/list-xls-worksheets-func.html at main · brianluft/website-sqlnotebook.com · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">


<title>LIST_XLS_WORKSHEETS Function - SQL Notebook</title>
<link rel="stylesheet" href="sqlnotebook.css">
</head>
<body>
<header>
<table class="nav">
<tr>
<td>
<a href="index.html"><img src="art/SqlNotebookIcon.png" alt="SQL Notebook (logo)" style="width: 58px; height: 58px; float: left; margin-right: 20px;"></a>
</td>
<td>
<a href="index.html" id="title">SQL Notebook</a><br>
<nav>
<ul class="nav">
<li><a href="https://github.com/brianluft/sqlnotebook/releases">Download</a></li>
<li><a href="doc.html"><span id="header-doc-long">Documentation</span><span id="header-doc-short">Docs</span></a></li>
<li><a href="https://github.com/brianluft/sqlnotebook">GitHub</a></li>
</ul>
</nav>
</td>
</tr>
</table>
<hr style="margin-top: 15px; margin-bottom: 15px;">
</header>
<article><div id="article">
<h1><code>LIST_XLS_WORKSHEETS</code> Function</h1>
  <p>Returns a table containing the names and index numbers of the worksheets in a particular Excel workbook. The
  workbook may be in <code>.XLS</code> or <code>.XLSX</code> format. This is a table-valued function that can be used
  in the <code>FROM</code> clause of a <code>SELECT</code> statement and can participate in joins as if it were a
  table.</p>
  <h2>Syntax</h2><code>LIST_XLS_WORKSHEETS(<i>file-path</i>)</code><br>
  <h2>Parameters</h2>
  <ul class="args">
    <li><i>file-path</i>: text<br>
    The absolute path of the <code>.XLS</code> or <code>.XLSX</code> workbook to inspect.</li>
  </ul>
  <h2>Return Value</h2>
  <blockquote>
    A table with the following columns:
    <table>
      <thead>
        <tr>
          <th style="text-align: left;">Column name</th>
          <th style="text-align: left;">Description</th>
          <th style="text-align: left;">Example value</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td><code>number</code></td>
          <td>1-based index</td>
          <td>1</td>
        </tr>
        <tr>
          <td><code>name</code></td>
          <td>Worksheet name</td>
          <td>"Sheet1"</td>
        </tr>
      </tbody>
    </table>
  </blockquote>
  <h2>Example</h2>
  <pre><i>-- Returns a table listing all the worksheets.</i><br>SELECT * FROM LIST_XLS_WORKSHEETS('C:\Workbook.xls');<br><br><i>-- Returns the name of the second worksheet, or an</i><i><br></i><i>-- empty table if there are fewer than 2 worksheets</i><i><br></i><i>-- in the workbook.</i><br>SELECT name FROM LIST_XLS_WORKSHEETS('C:\Workbook.xls') WHERE number = 2;<br></pre>
  <ul class="examples"></ul>
</div></article>
<footer><div id="footer">
<hr>
© 2016-2025 <a href="https://github.com/electroly">Brian Luft</a>
</div></footer>
</body>
</html>