Query index in couchdb and support dict syntax: _id in database

tiangolo commented 6 years ago

[x] Tick to sign-off your agreement to the Developer Certificate of Origin (DCO) 1.1
[x] You have added tests for any code changes
[x] You have updated the CHANGES.md
[x] You have completed the PR template below:

What

I added 2 things, I needed both of them at the same time so I ended up doing a single PR instead of 2, sorry for that.

Move create_query_index from CloudantDatabase to CouchDatabase as the JSON indexes for Mango queries are now part of CouchDB.
Add a feature to allow checking if a document exists in a DB without having to resort to try-catch blocks, using standard dict syntax:

_id = 'julia30'
doc_exists = _id in my_database

if doc_exists:
    print('doc with _id julia30 exists in DB')

How

create_query_index: move the method from one class to the other. Move the tests from Cloudant specific to CouchDB.
Add a dict override for __contains__ that checks in the remote DB if the document exists.

Testing

Create a CouchDatabase object and call the create_query_index the same way you would for a Cloudant database.

Issues

I didn't create an issue before solving it.

tiangolo commented 6 years ago

Thanks for the review @emlaver

About setting CouchDB to the latest Docker image, I don't see any documentation on how to specify the version of CouchDB in Travis using simple, standard Travis with services: https://docs.travis-ci.com/user/database-setup/#CouchDB

I know it could be quite simpler to with Docker.

And I see there are branch names in this repo related to migrating the tests to Docker.

Do you need help with some of that? I have "some" experience with Docker, but I don't want to do stuff that doesn't align with the plans of the team.

For example, this project is configured to run tests for a full app in Docker. And run them on Travis (and GitLab CI, etc. It's quite simple to change the CI system once it's all in Docker).

emlaver commented 6 years ago

@tiangolo I'm currently working in a branch to use Docker to run our tests against the 2.1.1 version. I'll open a PR and our team with review when it's ready.

tiangolo commented 6 years ago

Excellent, thanks for reporting back @emlaver .

BTW, I'm actually running my local tests against a Docker (Docker Compose) CouchDB. Please let me know if there's anything I can help with that.

And let me know if there's anything still missing here (in this PR) that should be fixed before your PR is ready (I already added the missing tests).

emlaver commented 6 years ago

@tiangolo I've merged the CouchDB 2.1.1 testing PR. Please rebase your PR.

tiangolo commented 6 years ago

Thanks @emlaver , that's great! :tada:

Done, rebased (also fixed an issue I had there) :heavy_check_mark:

tiangolo commented 6 years ago

Hi @emlaver , do you have any news about this? :grin:

tiangolo commented 6 years ago

Thanks @emlaver , done :white_check_mark:

tiangolo commented 6 years ago

:tada: Thanks!

emlaver commented 6 years ago

@tiangolo Thank you for your work!

cloudant / python-cloudant