@@ -18,87 +18,55 @@ yarn add spreadsheet-orm
1818
1919### Connection
2020``` typescript
21- import { SpreadsheetClient , Credentials } from ' spreadsheet-orm' ;
21+ import createSpreadsheetClient ,{ Credentials } from " spreadsheet-orm"
2222import credentials from " ./yourGoogleCredentials.json"
2323
2424const connectionParameters: Credentials = credentials
25- const spreadsheetClient = new SpreadsheetClient ({
26- email: credentials .client_email ,
27- privateKey: credentials .private_key ,
28- spreadsheetID: credentials .spreadsheetID
29- });
25+ const spreadsheetClient = createSpreadsheetClient ({
26+ email:connectionParameters .client_email ,
27+ privateKey:connectionParameters .private_key ,
28+ spreadsheetID:connectionParameters .spreadsheetID
29+ })
3030```
31-
3231### Query Operations
3332
3433#### Select
3534``` typescript
3635// Select all data from sheet
37- const results = await spreadsheetClient
38- .query ()
39- .select ()
40- .from (' Users' )
41- .execute ();
36+ const results = await spreadsheetClient .queryBuilder .select ().from (' Users' ).execute ();
4237
4338// Select with condition
44- const filtered = await spreadsheetClient
45- .query ()
46- .select ([' name' , ' class' ])
47- .from (' Users' )
48- .where (row => row [1 ] === ' John' )
49- .execute ();
39+ const filtered = await spreadsheetClient .queryBuilder .select ([' name' , ' class' ]).from (' Users' ).where (row => row [1 ] === ' John' ).execute ();
5040
5141// Chain multiple selects
52- const multiSelect = await spreadsheetClient
53- .query ()
54- .select ([' name' ])
55- .from (' Users' )
56- .where (row => row [1 ] === ' John' )
57- .and ([' class' ])
58- .from (' Students' )
59- .where (row => row [2 ] === ' A' )
60- .execute ();
42+ const multiSelect = await spreadsheetClient .queryBuilder
43+ .select ([' name' ]).from (' Users' ).where (row => row [1 ] === ' John' )
44+ .and ([' class' ]).from (' Students' ).where (row => row [2 ] === ' A' )
45+ .execute ();
6146```
6247
6348#### Insert
6449``` typescript
6550// Insert single row
66- const result = await spreadsheetClient
67- .query ()
68- .insert ([' John' , ' A' , ' 25' ])
69- .into (' Users' )
70- .execute ();
51+ const result = await spreadsheetClient .queryBuilder .insert ([' John' , ' A' , ' 25' ]).into (' Users' ).execute ();
7152
7253// Chain multiple inserts
73- const multiInsert = await spreadsheetClient
74- .query ()
75- .insert ([' John' , ' A' , ' 25' ])
76- .into (' Users' )
77- .and ([' Jane' , ' B' , ' 23' ])
78- .into (' Users' )
79- .execute ();
54+ const multiInsert = await spreadsheetClient .queryBuilder .
55+ insert ([' John' , ' A' , ' 25' ]).into (' Users' )
56+ .and ([' Jane' , ' B' , ' 23' ]).into (' Users' )
57+ .execute ();
8058```
8159
8260#### Update
8361``` typescript
8462// Update with condition
85- const updated = await spreadsheetClient
86- .query ()
87- .update ([' John Doe' , ' A+' , ' 26' ])
88- .from (' Users' )
89- .where (row => row [1 ] === ' John' )
90- .execute ();
63+ const updated = await spreadsheetClient .queryBuilder .update ([' John Doe' , ' A+' , ' 26' ]).from (' Users' ).where (row => row [1 ] === ' John' ).execute ();
9164```
9265
9366#### Delete
9467``` typescript
9568// Delete with condition
96- const deleted = await spreadsheetClient
97- .query ()
98- .delete ()
99- .from (' Users' )
100- .where (row => row [1 ] === ' John' )
101- .execute ();
69+ const deleted = await spreadsheetClient .queryBuilder .delete ().from (' Users' ).where (row => row [1 ] === ' John' ).execute ();
10270```
10371
10472## Error Handling
@@ -124,11 +92,7 @@ try {
12492### Query Execution Errors
12593``` typescript
12694try {
127- const result = await spreadsheetClient
128- .query ()
129- .select ([' name' ])
130- .from (' NonExistentSheet' )
131- .execute ();
95+ const result = await spreadsheetClient .queryBuilder .select ([' name' ]).from (' NonExistentSheet' ).execute ();
13296} catch (error ) {
13397 if (error .message .includes (" cannot find spreadsheet" )) {
13498 // Handle invalid spreadsheet ID
@@ -153,10 +117,4 @@ try {
153117- ** Development** : Starts the application in development mode with hot reloading.
154118 ``` bash
155119 yarn dev
156- ```
157-
158- ## Contributing
159- Contributions are welcome! Open an issue or submit a pull request.
160-
161- ## License
162- This project is licensed under the MIT License.
120+ ```
0 commit comments