{"id":26710,"date":"2024-03-28T09:30:00","date_gmt":"2024-03-28T08:30:00","guid":{"rendered":"https:\/\/www.codemotion.com\/magazine\/?p=26710"},"modified":"2024-04-04T15:29:21","modified_gmt":"2024-04-04T13:29:21","slug":"opendev-explorer-episodio-3-oramasearch-non-e-il-trovare-ma-il-cercare","status":"publish","type":"post","link":"https:\/\/www.codemotion.com\/magazine\/it\/backend-it\/opendev-explorer-episodio-3-oramasearch-non-e-il-trovare-ma-il-cercare\/","title":{"rendered":"OpenDev Explorer – Episodio 3 OramaSearch: Non \u00e8 il trovare, ma il cercare"},"content":{"rendered":"\n

Benvenuti a OpenDev Explorer, la mia rubrica dedicata all’esplorazione del mondo Open Source<\/a> che strizza un occchio alla developer experience. Io sono Riccardo (aka TheZal) e oggi vi parler\u00f2 di OramaSearch, un motore di ricerca open source battery included con zero dipendenze.<\/p>\n\n\n\n

Panoramica generale<\/strong><\/h2>\n\n\n\n

“It’s not the finding, but the searching” \u00e8 uno dei motti di OramaSearch, un motore di ricerca open source pronto out of the box e con zero dipendenze<\/strong>. Nato con un altro nome (Lyra) come esercizio per un talk di Michele Riva<\/a> per spiegare come funziona un motore di ricerca full-text, \u00e8 diventato poi un progetto vero e proprio grazie anche ai feedback della community (5800 stelle su GitHub e migliaia di download in pochi mesi<\/a>) che hanno trovato in Orama Search un potente e ottimizzato motore di ricerca semplice da usare e in grado di soddifare tutte le richieste della community.<\/p>\n\n\n\n

Manuale di istruzioni<\/strong><\/h2>\n\n\n\n

Installazione<\/strong><\/h3>\n\n\n\n

Installare OramaSearch \u00e8 semplicissimo, infatti \u00e8 disponibile in tutti i maggiori package manager (npm, yarn, pnpm) e pu\u00f2 essere installato con un semplice comando:<\/p>\n\n\n\n

<\/p>\n\n\n

npm<\/span> i<\/span> @orama<\/span>\/orama<\/code><\/span>Code language:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\n
<\/p>\n\n\n\n
Oppure \u00e8 possibile importarlo direttamente in un browser module:<\/p>\n\n\n\n
<\/p>\n\n\n
<html<\/span>><\/span>\n\n\u00a0 <body<\/span>><\/span>\n\n\u00a0 \u00a0 <script<\/span> type<\/span>=\"module\"<\/span>><\/span>\n\n\u00a0 \u00a0 \u00a0 import<\/span> { create, search, insert } from<\/span> 'https:\/\/unpkg.com\/@orama\/orama@latest\/dist\/index.js'<\/span>\n\n\u00a0 \u00a0 \u00a0 \/\/ ...<\/span>\n\n\u00a0 \u00a0 <\/span><\/script<\/span>><\/span>\n\n\u00a0 <\/body<\/span>><\/span>\n\n<\/html<\/span>><\/span><\/code><\/span>Code language:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
<\/p>\n\n\n\n
Utilizzo<\/strong><\/h3>\n\n\n\n
Come prima cosa \u00e8 necessario creare una nuova istanza (da ora in poi database) con un index schema.<\/p>\n\n\n\n
Lo schema rappresenta le propriet\u00e0 ricercabili del documento da inserire nel database. Risulta anche possibile avere delle propriet\u00e0 in pi\u00f9 non indicizzate, purch\u00e8 queste non ci servano nella ricerca.<\/p>\n\n\n\n
Un esempio di utilizzo (preso direttamente dalla documentazione ufficiale) \u00e8 il seguente:<\/p>\n\n\n\n
<\/p>\n\n\n
import<\/span> { create, search, insert } from<\/span> '@orama\/orama'<\/span>\n\nconst<\/span> db = await<\/span> create({\n\n\u00a0 schema<\/span>: {\n\n\u00a0 \u00a0 name<\/span>: 'string'<\/span>,\n\n\u00a0 \u00a0 description<\/span>: 'string'<\/span>,\n\n\u00a0 \u00a0 price<\/span>: 'number'<\/span>,\n\n\u00a0 \u00a0 meta<\/span>: {\n\n\u00a0 \u00a0 \u00a0 rating<\/span>: 'number'<\/span>,\n\n\u00a0 \u00a0 },\n\n\u00a0 },\n\n})\n\nawait<\/span> insert(db, {\n\n\u00a0 name<\/span>: 'Wireless Headphones'<\/span>,\n\n\u00a0 description<\/span>: 'Experience immersive sound quality with these noise-cancelling wireless headphones.'<\/span>,\n\n\u00a0 price<\/span>: 99.99<\/span>,\n\n\u00a0 meta<\/span>: {\n\n\u00a0 \u00a0 rating<\/span>: 4.5<\/span>,\n\n\u00a0 },\n\n})\n\nconst<\/span> searchResult = await<\/span> search(db, {\n\n\u00a0 term<\/span>: 'headphones'<\/span>,\n\n})\n\nconsole<\/span>.log(searchResult.hits.map((hit<\/span>) =><\/span> hit.document))<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
\n\n\n\n
\"Codemotion<\/a><\/figure>\n\n\n\n
\n\n\n\n
La developer experience<\/strong><\/h2>\n\n\n\n
Il pi\u00f9 grande successo di Orama Search \u00e8 dato dal fatto che sia stata la community a farlo diventare un progetto (e un prodotto) vero e proprio. La community, infatti, ha acclamato Orama grazie alla sua developer experience fantastica e alla sua semplicit\u00e0 d’uso.<\/p>\n\n\n\n
Ci sono diversi punti che vanno a migliorare la developer experience di OramaSearch:<\/p>\n\n\n\n
1 – La documentazione \u00e8 chiara e ben fatta<\/p>\n\n\n\n
2 – La community \u00e8 molto attiva e risponde in maniera molto rapida alle domande poste su GitHub o su Slack<\/p>\n\n\n\n
3 – La libreria \u00e8 molto ben scritta e permette di iniziare ad utilizzarla in pochi minuti<\/p>\n\n\n\n
4 – Orama fornisce diversi plugin ufficiali che permettono l’utilizzo di Orama in diversi contesti (come ad esempio su Astro)<\/p>\n\n\n\n
L’extra mile<\/strong><\/h2>\n\n\n\n
OramaSearch ha in alcune sue funzionalit\u00e0 un extra mile che lo rendono un motore di ricerca molto potente e flessibile.<\/p>\n\n\n\n
Essendo stato progettato per avere al suo interno un database vettoriale, OramaSearch implementa nativamente la ricerca vettoriale degli elementi.<\/p>\n\n\n\n
Inoltre implementa anche la funzionalit\u00e0 di geo search, che permette di cercare elementi in base alla loro posizione geografica.<\/p>\n\n\n\n
Il confronto con lo status quo<\/strong><\/h2>\n\n\n\n
Esistono diversi motori di ricerca full text (come ad esempio ElasticSearch) ma non credo che ce ne sia uno sul mercato che abbia nel suo arsenale le stesse armi che ha OramaSearch.<\/p>\n\n\n\n
Sono sicuro invece che al momento non esista un’utility potente come Orama che condivida la sua stessa semplicit\u00e0 d’uso, rendendo cos\u00ec Orama Search unico nel suo genere.<\/p>\n\n\n\n
Per quanto riguarda la velocit\u00e0 di ricerca, Orama Search \u00e8 uno dei motori di ricerca pi\u00f9 veloci che abbia mai provato, e questo \u00e8 un ennesimo punto a suo favore.<\/p>\n\n\n\n
\n\n\n\n
\n