New Datastore Interfaces

Aperta
#64 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
go
Ambito
database

Direzione di ricerca

Non vengono indicati file né test. Inizia esaminando le interfacce go-datastore esistenti, quindi confronta i design proposti per StreamingDatastore, ReadClosurer e OutParamer e la discussione precedente in #28; l'attività è completata quando è stato deciso un design dell'interfaccia e l'ambito è stato concordato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

The interfaces in go-datastore have been needing updating for a while. This came up in #28 so i decided to start the conversation up. Lets collect all these ideas together here so we can move forward with this.

Interface additions i've been looking for involve streaming interfaces:

type StreamingDatastore interface {
    // GetR returns a reader to read the value directly from the source (sans buffering)
    GetR(k ds.Key) (io.Reader, error)

    // PutW returns a new put writer that can be used to stream a value 
    // into the datastore
    PutW() (WritePutter, error)
}

// WritePutter is used to stream values into the datastore. Since the caller may not 
// know the key they want to store this value as until the write is complete (content 
// addressing) the key is set after the write is complete
type WritePutter interface{
    io.Writer
    FinishWithKey(k ds.Key) error
}

Also, for queries and maybe 'gets' in general, it would be nice to have a readonly view interface. Many storage backends (bolt in particular) allow you to read and operate on the data within the datastore without making a copy (i.e. using the datastores memory) within a closure. This would be really useful for things like 'load this protobuf object from disk' where we don't need our own copy of the bytes.

// A datastore implementing ReadClosurer allows passing a closure to operate
// on a readonly view of the data in question
type ReadClosurer interface {
    GetFunc(k ds.Key, func(i interface{}) error) error
}

Alternatively, this could be done with an output parameter and interfaces:

type OutParamer interface{
    GetOut(k ds.Key, out DSUnmarshaler) error
}

type DSUnmarshaler interface {
  DSUnmarshal(val []byte) error
}

This would behave similarly to the json.Unmarshaler interfaces.

Lingua principale
Go
Stelle
248
Fork
68
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ipfs/go-datastore

Tutte le issue di ipfs/go-datastore

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.