Skip to content

Commit

Permalink
Merge pull request #46 from cloudsufi/copla-changes
Browse files Browse the repository at this point in the history
[🍒][PLUGIN-1762][PLUGIN-1763][PLUGIN-1764][PLUGIN-1766]
  • Loading branch information
vikasrathee-cs authored Mar 28, 2024
2 parents 87cae71 + ded2ccf commit f8f690c
Show file tree
Hide file tree
Showing 20 changed files with 831 additions and 72 deletions.
5 changes: 5 additions & 0 deletions docs/GoogleDrive-batchsink.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ Make sure `Google Drive API` is enabled in the `GCP Project`.
OAuth2 client credentials can be generated on Google Cloud
[Credentials Page](https://console.cloud.google.com/apis/credentials)

**OAuth Method:** The method used to get OAuth access tokens. Users have the option to either directly provide
the OAuth access token or supply a client ID, client secret, and refresh token.

**Access Token:** Short lived access token used for connecting.

**Client ID:** OAuth2 client id used to identify the application.

**Client Secret:** OAuth2 client secret used to access the authorization server.
Expand Down
24 changes: 22 additions & 2 deletions docs/GoogleDrive-batchsource.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,26 @@ Properties
----------
### Basic

**Directory Identifier:** Identifier of the destination folder.
**Identifier Type:** Identifier specifies whether the given ID for Google Drive entity is a file or directory.

**Directory Identifier:** Identifier of the source folder.

This comes after `folders/` in the URL. For example, if the URL is
```
https://drive.google.com/drive/folders/1dyUEebJaFnWa3Z4n0BFMVAXQ7mfUH11g?resourcekey=0-XVijrJSp3E3gkdJp20MpCQ
```
Then the Directory Identifier would be `1dyUEebJaFnWa3Z4n0BFMVAXQ7mfUH11g`.

**File Identifier:** Identifier of the file.

This comes after `file/d/ or document/d/ or spreadsheets/d/` in the URL. For example, if the URL is
```
https://docs.google.com/file/d/17W3vOhBwe0i24OdVNsbz8rAMClzUitKeAbumTqWFrkows
```

Then the File Identifier would be `17W3vOhBwe0i24OdVNsbz8rAMClzUitKeAbumTqWFrkows`.
**Note:** Either Directory Identifier or File Identifier should have a value.

**File Metadata Properties:** Properties that represent metadata of files.
They will be a part of output structured record. Descriptions for properties can be view at
[Drive API file reference](https://developers.google.com/drive/api/v3/reference/files).
Expand Down Expand Up @@ -48,13 +60,21 @@ For Google Drive formats user should specify exporting format in **Exporting** s
**Authentication Type:** Type of authentication used to access Google API.

OAuth2 and Service Account types are available.
Make sure `Google Drive API` is enabled in the `GCP Project`.

Make sure that:
* `Google Drive API` is enabled in the `GCP Project`.
* `Google Drive Folder` is shared to the service account email used with the required permission.

#### OAuth2 Properties

OAuth2 client credentials can be generated on Google Cloud
[Credentials Page](https://console.cloud.google.com/apis/credentials)

**OAuth Method:** The method used to get OAuth access tokens. Users have the option to either directly provide
the OAuth access token or supply a client ID, client secret, and refresh token.

**Access Token:** Short lived access token used for connecting.

**Client ID:** OAuth2 client id used to identify the application.

**Client Secret:** OAuth2 client secret used to access the authorization server.
Expand Down
5 changes: 5 additions & 0 deletions docs/GoogleSheets-batchsink.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ Make sure `Google Drive API` and `Google Sheets API` is enabled in the `GCP Proj
OAuth2 client credentials can be generated on Google Cloud
[Credentials Page](https://console.cloud.google.com/apis/credentials)

**OAuth Method:** The method used to get OAuth access tokens. Users have the option to either directly provide
the OAuth access token or supply a client ID, client secret, and refresh token.

**Access Token:** Short lived access token used for connecting.

**Client ID:** OAuth2 client id used to identify the application.

**Client Secret:** OAuth2 client secret used to access the authorization server.
Expand Down
26 changes: 24 additions & 2 deletions docs/GoogleSheets-batchsource.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,25 @@ Properties
----------
### Basic

**Directory Identifier:** Identifier of the destination folder.
**Identifier Type:** Identifier specifies whether the given ID for Google Drive entity is a file or directory.

**Directory Identifier:** Identifier of the source folder.

This comes after `folders/` in the URL. For example, if the URL is
```
https://drive.google.com/drive/folders/1dyUEebJaFnWa3Z4n0BFMVAXQ7mfUH11g?resourcekey=0-XVijrJSp3E3gkdJp20MpCQ
```
Then the Directory Identifier would be `1dyUEebJaFnWa3Z4n0BFMVAXQ7mfUH11g`.

**File Identifier:** Identifier of the spreadsheet file.

This comes after `spreadsheets/d/` in the URL. For example, if the URL is
```
https://docs.google.com/spreadsheets/d/17W3vOhBwe0i24OdVNsbz8rAMClzUitKeAbumTqWFrkows
```
Then the File Identifier would be `17W3vOhBwe0i24OdVNsbz8rAMClzUitKeAbumTqWFrkows`.
**Note:** Either Directory Identifier or File Identifier should have a value.

### Filtering

**Filter:** Filter that can be applied to the files in the selected directory.
Expand Down Expand Up @@ -45,13 +56,21 @@ Is shown only when 'titles' or 'numbers' are selected for 'Sheets to pull' field
**Authentication Type:** Type of authentication used to access Google API.

OAuth2 and Service Account types are available.
Make sure `Google Drive API` and `Google Sheets API` is enabled in the `GCP Project`.

Make sure that:
* `Google Drive API` and `Google Sheets API` is enabled in the `GCP Project`.
* `Google Drive Folder` is shared to the service account email used with the required permission.

#### OAuth2 Properties

OAuth2 client credentials can be generated on Google Cloud
[Credentials Page](https://console.cloud.google.com/apis/credentials)

**OAuth Method:** The method used to get OAuth access tokens. Users have the option to either directly provide
the OAuth access token or supply a client ID, client secret, and refresh token.

**Access Token:** Short lived access token used for connecting.

**Client ID:** OAuth2 client id used to identify the application.

**Client Secret:** OAuth2 client secret used to access the authorization server.
Expand Down Expand Up @@ -121,6 +140,9 @@ _Treat first row as column names_ - the plugin uses first row for schema definin
**Column Names Row Number:** Number of the row to be treated as a header.
Only shown when the 'Column Names Selection' field is set to 'Custom row as column names' header.

**Auto Detect Number of Rows and Columns:** Field to enable automatic detection of the number of rows and columns to
read from the sheet.

**Number of Columns to Read:** Last column plugin will read as data. It will be ignored if the Column
Names Row contains less number of columns.

Expand Down
Loading

0 comments on commit f8f690c

Please sign in to comment.