Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kamilturek/db2ndb
A helper tool for DB to NDB client library migration
https://github.com/kamilturek/db2ndb
Last synced: 26 days ago
JSON representation
A helper tool for DB to NDB client library migration
- Host: GitHub
- URL: https://github.com/kamilturek/db2ndb
- Owner: kamilturek
- License: mit
- Created: 2023-07-13T20:41:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-02T20:32:02.000Z (over 1 year ago)
- Last Synced: 2024-05-01T16:06:53.699Z (6 months ago)
- Language: Python
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# db2ndb
db2ndb tool is a Python CLI tool that helps you with migrating your App Engine
Python application from `google.appengine.ext.db` to `google.appengine.ext.ndb`
as per the official [DB to NDB Client Library Migration](https://cloud.google.com/appengine/docs/legacy/standard/python/ndb/db_to_ndb)
guide.
## Installation
Not released yet but you can still install the development version from GitHub.
```sh
git clone [email protected]:kamilturek/db2ndb.git
cd db2ndb
pip install .
```
## Usage
To convert the file, run:
```sh
db2ndb app.py
```
The output will be printed to the standard output. Use `-w` option to modify the
file in place.
```sh
db2ndb -w app.py
```
All transformations are enabled by default.
To disable a specific transformation, use the `--disable` option.
```sh
db2ndb --disable T001 app.py
```
## Supported Transformations
### [Model class](https://cloud.google.com/appengine/docs/legacy/standard/python/ndb/db_to_ndb#model_class)
- `T001` - Replace `class MyModel(db.Model)` with `class MyModel(ndb.Model)`
- `T002` - Replace `def kind(cls):` with `def _get_kind(cls):`
- `T003` - Replace `MyModel.kind()` with `MyModel._get_kind()`
- `T004` - Replace `MyModel.properties()` with `MyModel._properties`
- `T005` - Replace `MyExpando.dynamic_properties()` with `MyExpando._properties`
### [Entities](https://cloud.google.com/appengine/docs/legacy/standard/python/ndb/db_to_ndb#entities)
- `T006` - Replace `MyModel(key_name='my_key')` with `MyModel(id='my_key')`
- `T007` - Replace `model_instance.key()` with `model_instance.key`
### [Properties](https://cloud.google.com/appengine/docs/legacy/standard/python/ndb/db_to_ndb#properties)
- `T008` - Replace `db.BlobProperty()` with `ndb.BlobProperty()`
- `T009` - Replace `db.BooleanProperty()` with `ndb.BooleanProperty()`
- `T010` - Replace `db.ByteStringProperty()` with `ndb.BlobProperty(indexed=True)`
- `T011` - Replace `db.CategoryProperty()` with `ndb.StringProperty()`
- `T012` - Replace `db.DateProperty()` with `ndb.DateProperty()`
- `T013` - Replace `db.DateTimeProperty()` with `ndb.DateTimeProperty()`
- `T014` - Replace `db.EmailProperty()` with `ndb.StringProperty()`
- `T015` - Replace `db.FloatProperty()` with `ndb.FloatProperty()`
- `T016` - Replace `db.GeoPtProperty()` with `ndb.GeoPtProperty()`
- `T017` - Replace `db.IntegerProperty()` with `ndb.IntegerProperty()`
- `T018` - Replace `db.LinkProperty()` with `ndb.StringProperty()`
- `T019` - Replace `db.ListProperty(bool)` with `ndb.BooleanProperty(repeated=True)`
- `T020` - Replace `db.ListProperty(float)` with `ndb.FloatProperty(repeated=True)`
- `T021` - Replace `db.ListProperty(int)` with `ndb.IntegerProperty(repeated=True)`
- `T022` - Replace `db.ListProperty(db.Key)` with `ndb.KeyProperty(repeated=True)`
- `T023` - Replace `db.PhoneNumberProperty()` with `ndb.StringProperty()`
- `T024` - Replace `db.PostalAddressProperty()` with `ndb.StringProperty()`
- `T025` - Replace `db.RatingProperty()` with `ndb.IntegerProperty()`
- `T026` - Replace `db.ReferenceProperty(AnotherModel)` with `db.KeyProperty(kind=AnotherModel)`
- `T027` - Replace `db.SelfReferenceProperty()` with `ndb.KeyProperty(kind='ThisModelClass')`
- `T028` - Replace `db.StringProperty()` with `ndb.StringProperty()`
- `T029` - Replace `db.StringProperty(multiline=True)` with `db.StringProperty()`
- `T030` - Replace `db.StringListProperty()` with `ndb.StringProperty(repeated=True)`
- `T031` - Replace `db.TextProperty()` with `ndb.TextProperty()`
- `T032` - Replace `db.TimeProperty()` with `ndb.TimeProperty()`
- `T033` - Replace `db.UserProperty()` with `ndb.UserProperty()`
- `T034` - Replace `blobstore.BlobReferenceProperty()` with `ndb.BlobKeyProperty()`
### [Get](https://cloud.google.com/appengine/docs/legacy/standard/python/ndb/db_to_ndb#get)
- `T035` - Replace `MyModel.get_by_key_name('my_key')` with `MyModel.get_by_id('my_key')`
- `T036` - Replace `db.get(key)` with `key.get()`
### [Put](https://cloud.google.com/appengine/docs/legacy/standard/python/ndb/db_to_ndb#get)
- `T037` - Replace `db.put(model_instance)` with `model_instance.put()`
## License
This project is licensed under the terms of the [MIT license](./LICENSE).