You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@
19
19
7.[Known issues, caveats and troubleshooting](#issues)
20
20
8.[Future plans](#future)
21
21
22
-
22
+
23
23
*Please have a quick look over the [Known issues, caveats and troubleshooting](#issues) section before using the app.*
24
24
25
25
<aname="what"></a>
@@ -41,22 +41,22 @@ Csv2Sql can automatically...
41
41
42
42
* It is **completely automatic**, provide a path with hundereds of csvs having size in gigabytes and start the application, it will handle the rest!
43
43
44
-
* It comes in **2 flavours**, as a **[command line tool](#cmd)** or a **[browser user interface](dashboard)**, and is super easy to configure and use.
44
+
* It comes in **2 flavours**, as a **[command line tool](#cmd)** or a **[browser user interface](#dashboard)**, and is super easy to configure and use.
45
45
46
46
* While you can have maximum utilization of your cpu to get execellent performance, csv2sql is fully **customizable**, also comes with [lots of options](#cmdargs) which can be changed to fine tune the application based on requirement and to lower down resource usage and database load.
47
47
48
48
* Csv2Sql supports **partial operations**, so if you only want to generate a schema file from the csvs without touching the database or you want to only insert data from the csvs into already created tables without creating the tables again or just validate already imported data, Csv2Sql has got you covere !
49
49
50
50
<aname="cmd"></a>
51
51
## Using from command line
52
-
52
+
53
53
Csv2sql can be easily used as a command line tool, with lots of customizable options passing by different command line arguments.
Download the executable binary from the latest release in this repository
77
+
Download the executable binary from the latest release in this repository
78
78
and run the executable using: ```./csv2sql --<argument>```
79
79
80
80
The next section describes all the avialable command line arguments.
@@ -86,7 +86,7 @@ You can pass various command line arguments to Csv2Sql to configure how to proce
86
86
87
87
A description of all the available command line arguments that can be used are given below:
88
88
89
-
89
+
90
90
| Flag | Description | Default value |
91
91
|:-----------:|----------------------|------|
92
92
|\-\-schema-file-path | The location were the generated schema file will be stored | If no value is supplied it saves the generated schema file in the same directory as the source csv files specified by "\-\-source-csv-directory" flag |
@@ -111,7 +111,7 @@ A description of all the available command line arguments that can be used are g
111
111
|\-\-pool-size | The pool_size controls how many connections you want to the database. | 20 |
112
112
|\-\-queue-target | The time to wait for a database connection | 5000 |
113
113
|\-\-queue-interval | If all connections checked out during a :queue_interval takes more than :queue_target, then we double the :queue_target. | 1000 |
114
-
114
+
115
115
<aname="cmdexamples"></a>
116
116
### Examples:
117
117
@@ -135,9 +135,9 @@ Here "postgres" is the database type.
Here we are running simple validation check over a previously imported csvs, this check will NOT compare the actual data but will only compare the row count in the csv and in the database.
142
142
143
143
---
@@ -157,18 +157,18 @@ This will create empty table in the database after analyzing the csvs.
##### Set the number of workers inserting data into the database, lowering the value will lead to slow performance but lesser load on database, a higher value can lead to too many database connection errors:
For ease of use csv2sql also has a browser interface which can be used to easily configure the tool and also provides and execent interface that shows what is the progress of the various running tasks, which files are currently being processed, the current cpu and memory usage, etc.
174
174
@@ -201,11 +201,11 @@ Now go to the `Change configuration` tab, and enter the relevant configuration d
201
201
Whenever your are done, click on the `Start` tab and click on `Start` button below to start the import process.
202
202
203
203
<aname="sourceinstall"></a>
204
-
## Running the app from source code
204
+
## Running the app from source code
205
205
206
206
You must have elixir and mysql/postgresql installed in your system to run Csv2Sql.
207
207
208
-
To use the app just clone this repository and then install dependencies
208
+
To use the app just clone this repository and then install dependencies
209
209
by `mix deps.get`
210
210
211
211
Finally, start the application by ```mix phx.server```
@@ -215,7 +215,7 @@ This runs the phoenix server at [localhost:4000](localhost:4000) which provides
215
215
Thats all !
216
216
217
217
<aname="support"></a>
218
-
## Supported data types
218
+
## Supported data types
219
219
220
220
Csv2sql currently supports [MySql](https://www.mysql.com/) and [PostgreSQL](https://www.postgresql.org/) database.
221
221
@@ -233,7 +233,7 @@ Csv2Sql will map data in CSVs into one of the following datatypes:
233
233
| text | TEXT | TEXT |
234
234
235
235
All other types of data, will map to either VARCHAR or TEXT.
236
-
236
+
237
237
<aname="issues"></a>
238
238
## Known issues, caveats and troubleshooting:
239
239
@@ -252,7 +252,7 @@ In this case, please try running the app again.
252
252
* Csvsql uses the csv file names as table names, make sure that the csv file names are valid table names.
253
253
254
254
* Make sure your csvs have correct encoding and valid column names to avoid errors.(like a csv having duplicated column names will lead to errors when inserting in to the database).
255
-
255
+
256
256
* If you face database connection timeout errors try reducing the worker and db_worker count in the configurations or change the database timeout, pool size and other related database configurations.
257
257
258
258
* In case of errors, check your terminal for a clue, or create an issue.
0 commit comments