Datastores

Verida Datastores are databases with a defined schema. By sharing a schema applications can share data more easily. Datastores ensure all data saved in them is valid by enforcing data validation. Read more about datastores here.

See a walk through of the code

Try it out

In this demo we show three things:

• how attempting to save a record with invalid data (in this case an email address) will fail (the saveBadContact function)
• how saving valid data is successful (the saveGoodContact function)
• how to retrieve all data (the showContacts function)

Live Editor

VeridaDatastoreExample = () => { const contactSchema = "https://common.schemas.verida.io/social/contact/v0.1.0/schema.json" const [currentMessage, setCurrentMessage] = useState(undefined) const [veridaContext, setVeridaContext] = useState(undefined) this.CONTEXT_NAME = "Verida Tutorial" React.useEffect(async () => { // See the login example for an explaination of this if (!veridaContext) { if (hasSession(this.CONTEXT_NAME)) { // we know we have a session already // globalLoginFunction is a globally defined version of the login function // See https://developers.verida.io/docs/tutorial/SSO let ctx = await globalLoginFunction(this.CONTEXT_NAME); setVeridaContext(ctx); } } }, []); let contact = { firstName: "John", lastName: "Smith", email: "", } processSaveResult = function (result, errors) { if (result) { setCurrentMessage("Successfully saved") } else { let errorMessage = [] errorMessage.push(<div>Failed to save!</div>) errorMessage.push( errors.map((error, idx) => ( <div key={idx}>Error is: {error.message}</div> )) ) setCurrentMessage(errorMessage) } } saveBadContact = async function () { let contactsDS = await veridaContext.openDatastore(contactSchema) contact.email = "john_smith.example.com" // notice the BAD email address setCurrentMessage("saving with email address " + contact.email) let result = await contactsDS.save(contact) processSaveResult(result, contactsDS.errors) } saveGoodContact = async function () { let contactsDS = await veridaContext.openDatastore(contactSchema) contact.email = "john_smith@example.com" // notice the GOOD email address setCurrentMessage("saving with email address " + contact.email) let result = await contactsDS.save(contact) processSaveResult(result, contactsDS.errors) } showContacts = async function () { let contactsDS = await veridaContext.openDatastore(contactSchema) contacts = await contactsDS.getMany(null, null) msg = [] msg.push( contacts.map((contact, index) => ( <div key={index}> {contact.firstName} {contact.lastName}: {contact.email} </div> )) ) setCurrentMessage(msg) } // if we have a veridaContext we are logged in if (veridaContext) { // user is logged in return ( <div> <button onClick={this.saveBadContact}> Attempt to save an invalid contact </button> <br /> <button onClick={this.saveGoodContact}> Attempt to save an valid contact </button> <br /> <button onClick={this.showContacts}>Show contacts</button> <div>{currentMessage}</div> </div> ) } else { return ( <div className="admonition admonition-danger alert alert--danger"> <h2> Please login <a href="/docs/tutorial/SSO#runcode">here</a> </h2> </div> ) } }

VeridaDatastoreExample = () => {
  const contactSchema =
    "https://common.schemas.verida.io/social/contact/v0.1.0/schema.json"
  const [currentMessage, setCurrentMessage] = useState(undefined)
  const [veridaContext, setVeridaContext] = useState(undefined)
  this.CONTEXT_NAME = "Verida Tutorial"

  React.useEffect(async () => {
    // See the login example for an explaination of this
    if (!veridaContext) {
      if (hasSession(this.CONTEXT_NAME)) {
        // we know we have a session already
        // globalLoginFunction is a globally defined version of the login function 
        // See https://developers.verida.io/docs/tutorial/SSO
        let ctx = await globalLoginFunction(this.CONTEXT_NAME);
        setVeridaContext(ctx);
      }
    }
  }, []);

  let contact = {
    firstName: "John",
    lastName: "Smith",
    email: "",
  }

  processSaveResult = function (result, errors) {
    if (result) {
      setCurrentMessage("Successfully saved")
    } else {
      let errorMessage = []

      errorMessage.push(<div>Failed to save!</div>)

      errorMessage.push(
        errors.map((error, idx) => (
          <div key={idx}>Error is: {error.message}</div>
        ))
      )
      setCurrentMessage(errorMessage)
    }
  }

  saveBadContact = async function () {
    let contactsDS = await veridaContext.openDatastore(contactSchema)

    contact.email = "john_smith.example.com" // notice the BAD email address

    setCurrentMessage("saving with email address " + contact.email)

    let result = await contactsDS.save(contact)
    processSaveResult(result, contactsDS.errors)
  }

  saveGoodContact = async function () {
    let contactsDS = await veridaContext.openDatastore(contactSchema)

    contact.email = "john_smith@example.com" // notice the GOOD email address

    setCurrentMessage("saving with email address " + contact.email)

    let result = await contactsDS.save(contact)
    processSaveResult(result, contactsDS.errors)
  }

  showContacts = async function () {
    let contactsDS = await veridaContext.openDatastore(contactSchema)

    contacts = await contactsDS.getMany(null, null)

    msg = []
    msg.push(
      contacts.map((contact, index) => (
        <div key={index}>
          {contact.firstName} {contact.lastName}: {contact.email}
        </div>
      ))
    )
    setCurrentMessage(msg)
  }

  // if we have a veridaContext we are logged in
  if (veridaContext) {
    // user is logged in
    return (
      <div>
        <button onClick={this.saveBadContact}>
          Attempt to save an invalid contact
        </button>
        <br />
        <button onClick={this.saveGoodContact}>
          Attempt to save an valid contact
        </button>
        <br />
        <button onClick={this.showContacts}>Show contacts</button>
        <div>{currentMessage}</div>
      </div>
    )
  } else {
    return (
      <div className="admonition admonition-danger alert alert--danger">
        <h2>
          Please login <a href="/docs/tutorial/SSO#runcode">here</a>
        </h2>
      </div>
    )
  }
}

Result

Loading...

 

Database documentation

See the Verida Datastore documentation for complete documentation.