Skip to content

Commit

Permalink
Merge pull request #60 from hasathcharu/main
Browse files Browse the repository at this point in the history
Update `Package.md` and `Module.md` with new tooling changes
  • Loading branch information
daneshk authored Apr 5, 2024
2 parents 5970ef7 + 4b3b1f1 commit 318ca8e
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 11 deletions.
40 changes: 34 additions & 6 deletions ballerina/Module.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,40 @@
# Module Overview
# Overview

This module provides Google sheets support for the `bal persist` feature, which provides functionality to store and query data from a Google sheets conveniently through a data model.
This package provides Google sheets support for the `bal persist` feature, which provides functionality to store and query data from a Google sheets conveniently through a data model.

The Google Sheets data store is a cloud-based spreadsheet application that stores data in tables. The Google Sheets data store is useful for storing data in a spreadsheet format. The Google Sheets data store is not the default data store for the `bal persist` feature. Therefore, you need to explicitly specify the data store when initializing Ballerina Persistence in your application. like below,
The Google Sheets data store is a cloud-based spreadsheet application that stores data in tables. The Google Sheets data store is useful for storing data in a spreadsheet format.

```
$ bal persist init --datastore googlesheets
```
## How to use with `bal persist`

By default, `bal persist` utilizes the in-memory data store. Therefore, you must explicitly specify Google Sheets data store as follows:

### Integrate to `bal build`

1. Initialize `bal persist` and integrate to `bal build` using the following command,

```
$ bal persist add --datastore googlesheets --module <module_name>
```
2. After defining the entities, build the application using the following command,
```
$ bal build
```
### One time generation
1. Initialize `bal persist` using the following command,
```
$ bal persist init
```
2. Generate the persist client using the following command,
```
$ bal persist generate --datastore googlesheets --module <module_name>
```

## Supported Ballerina Types
The following table lists the Ballerina types supported by the Google Sheets data store and the corresponding Google Sheets types used to store the data in the spreadsheet.
Expand Down
38 changes: 33 additions & 5 deletions ballerina/Package.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,40 @@
## Package overview
# Overview

This package provides Google sheets support for the `bal persist` feature, which provides functionality to store and query data from a Google sheets conveniently through a data model.

The Google Sheets data store is a cloud-based spreadsheet application that stores data in tables. The Google Sheets data store is useful for storing data in a spreadsheet format. The Google Sheets data store is not the default data store for the `bal persist` feature. Therefore, you need to explicitly specify the data store when initializing Ballerina Persistence in your application. like below,
The Google Sheets data store is a cloud-based spreadsheet application that stores data in tables. The Google Sheets data store is useful for storing data in a spreadsheet format.

```
$ bal persist init --datastore googlesheets
```
## How to use with `bal persist`

By default, `bal persist` utilizes the in-memory data store. Therefore, you must explicitly specify Google Sheets data store as follows:

### Integrate to `bal build`

1. Initialize `bal persist` and integrate to `bal build` using the following command,

```
$ bal persist add --datastore googlesheets --module <module_name>
```
2. After defining the entities, build the application using the following command,
```
$ bal build
```
### One time generation
1. Initialize `bal persist` using the following command,
```
$ bal persist init
```
2. Generate the persist client using the following command,
```
$ bal persist generate --datastore googlesheets --module <module_name>
```

## Supported Ballerina Types
The following table lists the Ballerina types supported by the Google Sheets data store and the corresponding Google Sheets types used to store the data in the spreadsheet.
Expand Down

0 comments on commit 318ca8e

Please sign in to comment.