Skip to content

Commit d73ace0

Browse files
committed
Docs update
1 parent 2bd4b05 commit d73ace0

23 files changed

+293
-33
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@ VBA CSV interface is the most complete, and open source, CSV/TSV VBA parser libr
1010
* __Memory-friendly__. CSV/[TSV](https://www.iana.org/assignments/media-types/text/tab-separated-values) files are processed using a custom stream technique, only 0.5MB are in memory at a time.
1111
* __Easy to use__. A few lines of code can do the work!
1212
* __Highly Configurable__. User can configure the parser to work with a wide range of CSV files.
13+
* __Like SQL queries on CSV files__. Add your own logic to mimic SQL queries and filter data by criteria (=, <>, >=, <=, AND, OR).
1314
* __Automatic delimiter guesser__. Don't worry if you forgot the file configuration!
14-
* __Flexible__. Import only certain range of records from the given file, import fields (columns) by indexes or names.
15+
* __Flexible__. Import only certain range of records from the given file, import fields (columns) by indexes or names, read records in sequential mode.
1516
* __Dynamic Typing support__. Turn CSV data field to a desired VBA data type.
16-
* __Data sorting__. Sort CSV imported data using the hyper-fast [Yaroslavskiy Dual-Pivot Quicksort](https://web.archive.org/web/20151002230717/http://iaroslavski.narod.ru/quicksort/DualPivotQuicksort.pdf) like Java.
17+
* __Data sorting__. Sort CSV imported data using the hyper-fast(100k records per second) [Yaroslavskiy Dual-Pivot Quicksort](https://web.archive.org/web/20151002230717/http://iaroslavski.narod.ru/quicksort/DualPivotQuicksort.pdf) like Java.
1718
* __Microsoft Access compatible__. The library has a version for those who feel in comfort working through DAO databases, [download from here](https://github.com/ws-garcia/VBA-CSV-interface/raw/master/src/Access_version.zip).
1819
* __RFC-4180 specs compliant__.
1920

docs/api/methods/closeseqreader.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: CloseSeqReader
3+
parent: Methods
4+
grand_parent: API
5+
nav_order: 2
6+
---
7+
8+
# CloseSeqReader
9+
{: .d-inline-block }
10+
11+
New
12+
{: .label .label-purple }
13+
14+
Closes an open sequential reader.
15+
{: .fs-6 .fw-300 }
16+
17+
---
18+
19+
## Syntax
20+
21+
*expression*.`CloseSeqReader`
22+
23+
### Parameters
24+
25+
_None_
26+
27+
### Returns value
28+
29+
_None_
30+
31+
See also
32+
: [OpenSeqReader Method](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/openseqreader.html), [GetRecord Method](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/getrecord.html).
33+
34+
[Back to Methods overview](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/)

docs/api/methods/createjagged.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: CreateJagged
33
parent: Methods
44
grand_parent: API
5-
nav_order: 2
5+
nav_order: 3
66
---
77

88
# CreateJagged

docs/api/methods/dumptoaccesstable.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: DumpToAccessTable
33
parent: Methods
44
grand_parent: API
5-
nav_order: 3
5+
nav_order: 4
66
---
77

88
# DumpToAccessTable
@@ -66,7 +66,7 @@ See also
6666

6767
## Behavior
6868

69-
If a table named *tableName* already exist in the database, the operation is aborted. User can specify the fields for create indexes by name or by absolute position through the *fieldsToIndexing* parameter. When the *fieldsToIndexing* parameter is not set, the data is dumped into the database table without indexing more fields than the record position.
69+
If a table named *tablename* already exists in the database, the method will attempt to append the data. User can specify the fields for create indexes by name or by absolute position through the *fieldsToIndexing* parameter. When the *fieldsToIndexing* parameter is not set, the data is dumped into the database table without indexing more fields than the record position.
7070

7171
>⚠️**Caution**
7272
>{: .text-grey-lt-000 .bg-green-000 }

docs/api/methods/dumptoarray.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,41 @@
22
title: DumpToArray
33
parent: Methods
44
grand_parent: API
5-
nav_order: 4
5+
nav_order: 5
66
---
77

88
# DumpToArray
99
{: .fs-9 }
1010

11-
Dumps the data from the current instance to an array.
11+
Dumps data from a source, or from the current instance, to an array.
1212
{: .fs-6 .fw-300 }
1313

1414
---
1515

1616
## Syntax
1717

18-
*expression*.`DumpToArray`*(OutPutArray)*
18+
*expression*.`DumpToArray`*(OutPutArray, \[DataSource:= `Nothing`\])*
1919

2020
### Parameters
2121

22-
The required *OutPutArray* argument is an identifier specifying a dynamic `String` type array variable.
22+
<table>
23+
<thead>
24+
<tr>
25+
<th style="text-align: left;">Part</th>
26+
<th style="text-align: left;">Description</th>
27+
</tr>
28+
</thead>
29+
<tbody>
30+
<tr>
31+
<td style="text-align: left;"><em>OutPutArray</em></td>
32+
<td style="text-align: left;">Required. Identifier specifying a dynamic <code>Variant</code> Type array variable.</td>
33+
</tr>
34+
<tr>
35+
<td style="text-align: left;"><em>DataSource</em></td>
36+
<td style="text-align: left;">Optional. Identifier specifying a <code>ECPArrayList</code> object variable representing the data to copy from.</td>
37+
</tr>
38+
</tbody>
39+
</table>
2340

2441
### Returns value
2542

@@ -37,7 +54,7 @@ See also
3754

3855
## Behavior
3956

40-
The `DumpToArray` method makes a copy of all the data stored in the current instance. The data is returned in the *OutPutArray* parameter for avoid additional data copies in the internals.
57+
When the *DataSource* parameter is omitted the `DumpToArray` method makes a copy of all data stored in the current instance. If the user specified a data source, its data is copied and returned in the *OutPutArray* parameter.
4158

4259
>⚠️**Caution**
4360
>{: .text-grey-lt-000 .bg-green-000 }

docs/api/methods/dumptojaggedarray.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,41 @@
22
title: DumpToJaggedArray
33
parent: Methods
44
grand_parent: API
5-
nav_order: 5
5+
nav_order: 6
66
---
77

88
# DumpToJaggedArray
99
{: .fs-9 }
1010

11-
Dumps the data from the current instance to a jagged array.
11+
Dumps data from a source, or from the current instance, to a jagged array.
1212
{: .fs-6 .fw-300 }
1313

1414
---
1515

1616
## Syntax
1717

18-
*expression*.`DumpToJaggedArray`*(OutPutArray)*
18+
*expression*.`DumpToJaggedArray`*(OutPutArray, \[DataSource:= `Nothing`\])*
1919

2020
### Parameters
2121

22-
The required *OutPutArray* argument is an identifier specifying a dynamic `Variant` type array variable.
22+
<table>
23+
<thead>
24+
<tr>
25+
<th style="text-align: left;">Part</th>
26+
<th style="text-align: left;">Description</th>
27+
</tr>
28+
</thead>
29+
<tbody>
30+
<tr>
31+
<td style="text-align: left;"><em>OutPutArray</em></td>
32+
<td style="text-align: left;">Required. Identifier specifying a dynamic <code>Variant</code> Type array variable.</td>
33+
</tr>
34+
<tr>
35+
<td style="text-align: left;"><em>DataSource</em></td>
36+
<td style="text-align: left;">Optional. Identifier specifying a <code>ECPArrayList</code> object variable representing the data to copy from.</td>
37+
</tr>
38+
</tbody>
39+
</table>
2340

2441
### Returns value
2542

@@ -37,7 +54,7 @@ See also
3754

3855
## Behavior
3956

40-
The `DumpToJaggedArray` method makes a copy of all the data stored in the current instance. The data is returned in the *OutPutArray* parameter for avoid additional data copies in the internals.
57+
When the *DataSource* parameter is omitted the `DumpToJaggedArray` method makes a copy of all data stored in the current instance. If the user specified a data source, its data is copied and returned in the *OutPutArray* parameter.
4158

4259
>📝**Note**
4360
>{: .text-grey-lt-000 .bg-green-000 }

docs/api/methods/dumptosheet.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22
title: DumpToSheet
33
parent: Methods
44
grand_parent: API
5-
nav_order: 6
5+
nav_order: 7
66
---
77

88
# DumpToSheet
99
{: .fs-9 }
1010

11-
Dumps the data from the current instance to an Excel WorkSheet.
11+
Dumps data from a source, or from the current instance, to an Excel WorkSheet.
1212
{: .fs-6 .fw-300 }
1313

1414
---
1515

1616
## Syntax
1717

18-
*expression*.`DumpToSheet`*(\[WBookName\], \[SheetName\], \[RngName:= "A1"\])*
18+
*expression*.`DumpToSheet`*(\[WBookName\], \[SheetName\], \[RngName:= "A1"\], \[DataSource:= `Nothing`\])*
1919

2020
### Parameters
2121

@@ -39,6 +39,10 @@ Dumps the data from the current instance to an Excel WorkSheet.
3939
<td style="text-align: left;"><em>RngName</em></td>
4040
<td style="text-align: left;">Optional. Identifier specifying a <code>String</code> Type variable representing the name of the output top left-most range.</td>
4141
</tr>
42+
<tr>
43+
<td style="text-align: left;"><em>DataSource</em></td>
44+
<td style="text-align: left;">Optional. Identifier specifying a <code>ECPArrayList</code> object variable representing the data to copy from.</td>
45+
</tr>
4246
</tbody>
4347
</table>
4448

@@ -60,4 +64,9 @@ See also
6064

6165
When the *WBookName* parameter is omitted the data is dumped into the Workbook that holds the CSV interface's *VBAProject*. Omitting the *SheetName* parameter adds a new Worksheet to the desired Workbook. Also, if the *RngName* parameter is omitted the data will dumped starting on the "A1" named cell in the desired Worksheet.
6266

67+
>📝**Note**
68+
>{: .text-grey-lt-000 .bg-green-000 }
69+
>When the *DataSource* parameter is omitted the `DumpToSheet` method dumps all data stored in the current instance. If the user specified a data source, its data will be dumped.
70+
{: .text-grey-dk-300 .bg-grey-lt-000 }
71+
6372
[Back to Methods overview](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/)

docs/api/methods/exporttocsv.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: ExportToCSV
33
parent: Methods
44
grand_parent: API
5-
nav_order: 7
5+
nav_order: 8
66
---
77

88
# ExportToCSV

docs/api/methods/getdatafromcsv.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: GetDataFromCSV
33
parent: Methods
44
grand_parent: API
5-
nav_order: 8
5+
nav_order: 9
66
---
77

88
# GetDataFromCSV

docs/api/methods/getrecord.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: GetRecord
3+
parent: Methods
4+
grand_parent: API
5+
nav_order: 11
6+
---
7+
8+
# GetRecord
9+
{: .d-inline-block }
10+
11+
New
12+
{: .label .label-purple }
13+
14+
Reads a new record from the CSV sequentially forward.
15+
{: .fs-6 .fw-300 }
16+
17+
---
18+
19+
## Syntax
20+
21+
*expression*.`GetRecord`
22+
23+
### Parameters
24+
25+
_None_
26+
27+
### Returns value
28+
29+
*Type*: `ECPArrayList`
30+
31+
See also
32+
: [CloseSeqReader Method](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/closeseqreader.html), [OpenSeqReader Method](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/openseqreader.html).
33+
34+
---
35+
36+
## Behavior
37+
38+
The `GetRecord` method returns an `ECPArrayList` object containing the data of a CSV record. If an error occurs or the end of file (EOF) is reached, the method returns `Nothing`.
39+
40+
[Back to Methods overview](https://ws-garcia.github.io/VBA-CSV-interface/api/methods/)

0 commit comments

Comments
 (0)