Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade guide to v1.1 #151

Merged
merged 4 commits into from
Jun 14, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,10 @@

## Not released

- Update TypeScript typings to Cloud Native [#147](https://github.com/CartoDB/carto-react/pull/147)
- Remove SourceTypes from react-api public api [#147](https://github.com/CartoDB/carto-react/pull/147)
- Add support to CARTO Cloud Native [#142](https://github.com/CartoDB/carto-react/pull/142)
- Update TypeScript typings to Cloud Native and remove SourceTypes from react-api public api[#147](https://github.com/CartoDB/carto-react/pull/147)
- Add support to Cloud Native SQL API [#150](https://github.com/CartoDB/carto-react/pull/150)

## (prerelease) 1.1.0-alpha.2 (2021-05-28)
## (prerelease) 1.1.0-alpha.1 (2021-05-27)
## (prerelease) 1.1.0-alpha.0 (2021-05-26)

- Initial Cloud native integration.

## 1.0.1 (2021-04-12)

Expand Down
29 changes: 29 additions & 0 deletions docs/upgrade-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Upgrade Guide

## Upgrading from @carto/react v1.0 to v1.1

### executeSQL parameters via destructuring

ExecuteSQL parameters are passed using object destructuring.

```javascript
executeSQL({ credentials, query })
```

### Credentials apiVersion

A new `apiVersion` parameter is included in cartoSlice to indicate the CARTO API to be used.

```javascript
import { API_VERSIONS } from '@deck.gl/carto';

export const initialState = {
...
,
credentials: {
apiVersion: API_VERSIONS.V2,
...
}
...
}
```