tarantool/migrate

Document flags argument in DML callbacks

Open

#11 opened on Jul 23, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Lua (0 forks)auto 404
backlogdocumentationgood first issueprio4

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

Description

From README:

spaces is a table that associates old space number and table with definitions:

  • insert - custom insert function function(tuple, flags). If not defined, a function that inserts a tuple into a space with new_id.
  • delete - custom delete function function(key, flags). If not defined, a function that deletes a tuple with a key from a space with new_id.
  • update - custom update function function(key, ops, flags. If not defined, a function that executes update with operations ops in a space with new_id on a tuple with PK key.

Meaning of flags is not described anywhere.

Contributor guide

Research direction
Examine the migrate module source code to understand the purpose and possible values of the `flags` argument in DML callbacks, then add a description to the README.
Tech stack
lua
Domain
backenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90