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

Jump to bottom

revisit API names for redundancy, e.g. shorten `xata.database().createDatabase()` to `xata.database().create()` #93

Closed

Tracked by

philkra opened this issue May 10, 2023 · 0 comments · Fixed by #95

Labels

breaking change codegen

Contributor

philkra commented May 10, 2023 •

edited

`databases`

getDatabaseMetadata -> getMetadata
createDatabase -> create
deleteDatabase -> delete
updateDatabaseMetadata -> updateMetadata
listRegions -> getRegions

`users`

getUser -> get
updateUser -> update
deleteUser -> delete

`workspaces`

getWorkspacesList -> getWorkspaces
createWorkspace -> create
getWorkspace -> get
updateWorkspace -> update
deleteWorkspace -> delete
getWorkspaceMembersList -> getMembers
updateWorkspaceMemberRole -> updateMember
removeWorkspaceMember -> removeMember

`branch`

getBranchList -> getBranches
getBranchDetails -> getDetails
createBranch -> create
deleteBranch -> delete
getBranchMetadata -> getMetadata
updateBranchMetadata -> updateMetadata
getBranchStats -> getStats
resolveBranch -> resolve

`migrations`

getBranchMigrationHistory -> getHistory
getBranchMigrationPlan -> getPlan
executeBranchMigrationPlan -> executePlan
getBranchSchemaHistory -> getHistory
compareBranchSchemas -> compare
updateBranchSchemas -> update
previewBranchSchemaEdit -> preview
applyBranchSchemaEdit -> apply
pushBranchMigrations -> push

`records`

insertRecord -> insert
getRecord -> get
insertRecordWithID -> insertWithId
upsertRecordWithID -> upsertWithId
deleteRecord -> delete
updateRecordWithID -> updateWithId
bulkInsertTableRecords -> bulkInsert

`search_and_filter`

queryTable -> query
vectorSearchTable -> vectorSearch
askTable -> ask
summarizeTable -> summarize
aggregateTable -> aggregate

`table`

createTable -> create
deleteTable -> delete
updateTable -> update
getTableSchema -> getSchema
setTableSchema -> setSchema
getTableColumns -> getColumns
addTableColumn -> addColumn

The text was updated successfully, but these errors were encountered:

philkra mentioned this issue

Closed

philkra added the codegen label

philkra mentioned this issue

API renaming #95

Merged

philkra closed this as completed in #95

philkra added the breaking change label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment