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.

Sign up for GitHub

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

Jump to bottom

docs on options include two incorrect keys and need usage examples #551

Open
JonThom opened this issue Aug 18, 2021 · 2 comments
Open

docs on options include two incorrect keys and need usage examples #551

JonThom opened this issue Aug 18, 2021 · 2 comments
Assignees
@alexjpwalker
Labels
priority: high type: bug
Milestone
TypeDB Client: Ru...

Comments

@JonThom
Copy link
Contributor

JonThom commented Aug 18, 2021 •
edited
Loading

Description

In the client python docs section on options,

  1. two option names are out of date.
  2. it should provide an example of how to instantiate the options object

Location of Content

https://docs.vaticle.com/docs/client-api/python#options

Expected Content

  1. correct option names
  2. an example of how to instantiate the options object

Actual Content

the listed options include two which have since changed name:
batch_size (now prefetch_size)
schema_lock_timeout_acquire_millis (now schema_lock_acquire_timeout_millis)

Additional information

This likely also applies to other places in the docs describing options
@jmsfltchr jmsfltchr added this to the Bug Fixes milestone Nov 4, 2021
@alexjpwalker alexjpwalker mentioned this issue Dec 30, 2021
Merged
alexjpwalker pushed a commit that referenced this issue Jan 7, 2022
Fix incorrectly named options (#583)
8e43163 
## What is the goal of this PR?

`prefetchSize` was still going by its old name `batchSize`, and there was a typo in `schemaLockAcquireTimeoutMillis` - both are now fixed.

## What are the changes implemented in this PR?

Rename `batchSize` option to `prefetchSize`
Rename `schemaLockTimeoutAcquireMillis` option to `schemaLockAcquireTimeoutMillis`

this PR forms part of #551
@alexjpwalker
Copy link
Member

We should add an example of instantiating TypeDBOptions to every language.

@izmalk
Copy link
Contributor

izmalk commented Jan 10, 2023 •
edited
Loading

The options were updated in #583.
An example of usage would be useful here.

Python:

TB = TypeDBOptions.core()  # Initialising a new set of options
TB.infer = True  # Enabling inference in this new set of options

...

with session.transaction(TransactionType.READ, TB) as transaction:

@izmalk izmalk mentioned this issue Jan 10, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alexjpwalker alexjpwalker

Labels
priority: high type: bug
Projects
None yet
Milestone
TypeDB Client: Rust Rewrite
Development

No branches or pull requests
4 participants
@alexjpwalker @JonThom @jmsfltchr @izmalk