typesense go Unduh - typesense go Unduh kode sumber

mengetik-pergi

Buka klien untuk Typesense API: https://github.com/typesense/typesense

Instalasi

 go get github.com/typesense/typesense-go/v2/typesense

Penggunaan

Impor paket ke dalam kode Anda:

 import "github.com/typesense/typesense-go/v2/typesense"

Buat klien baru:

 client := typesense . NewClient (
	    typesense . WithServer ( "http://localhost:8108" ),
	    typesense . WithAPIKey ( "<API_KEY>" ))

Klien baru dengan opsi konfigurasi lanjutan (lihat godoc):

 client := typesense . NewClient (
		typesense . WithServer ( "http://localhost:8108" ),
		typesense . WithAPIKey ( "<API_KEY>" ),
		typesense . WithConnectionTimeout ( 5 * time . Second ),
		typesense . WithCircuitBreakerMaxRequests ( 50 ),
		typesense . WithCircuitBreakerInterval ( 2 * time . Minute ),
		typesense . WithCircuitBreakerTimeout ( 1 * time . Minute ),
	)

Klien baru dengan opsi konfigurasi multi-node:

 client := typesense . NewClient (
		typesense . WithNearestNode ( "https://xxx.a1.typesense.net:443" ),
		typesense . WithNodes ([] string {
			"https://xxx-1.a1.typesense.net:443" ,
			"https://xxx-2.a1.typesense.net:443" ,
			"https://xxx-3.a1.typesense.net:443" ,
		}),
		typesense . WithAPIKey ( "<API_KEY>" ),
		typesense . WithNumRetries ( 5 ),
		typesense . WithRetryInterval ( 1 * time . Second ),
		typesense . WithHealthcheckInterval ( 2 * time . Minute ),
	)

Anda juga dapat menemukan beberapa contoh dalam pengujian integrasi.

Buat koleksi

	schema := & api. CollectionSchema {
		Name : "companies" ,
		Fields : []api. Field {
			{
				Name : "company_name" ,
				Type : "string" ,
			},
			{
				Name : "num_employees" ,
				Type : "int32" ,
			},
			{
				Name :  "country" ,
				Type :  "string" ,
				Facet : true ,
			},
		},
		DefaultSortingField : pointer . String ( "num_employees" ),
	}

	client . Collections (). Create ( context . Background (), schema )

Operasi dokumen yang diketik

Di v2.0.0 +, klien memungkinkan Anda menentukan struct dokumen yang akan digunakan untuk beberapa operasi dokumen.

Untuk melakukan itu, Anda harus menggunakan typesense.GenericCollection :

 type companyDocument struct {
    ID           string `json:"id"`
    CompanyName  string `json:"company_name"`
    NumEmployees int    `json:"num_employees"`
    Country      string `json:"country"`
}

// doc is a typed document
doc , err := typesense . GenericCollection [ * companyDocument ]( typesenseClient , collectionName ). Document ( "123" ). Retrieve ( context . Background ())

Indeks dokumen

	document := struct {
		ID           string `json:"id"`
		CompanyName  string `json:"company_name"`
		NumEmployees int    `json:"num_employees"`
		Country      string `json:"country"`
	}{
		ID :           "123" ,
		CompanyName :  "Stark Industries" ,
		NumEmployees : 5215 ,
		Country :      "USA" ,
	}

	client . Collection ( "companies" ). Documents (). Create ( context . Background (), document )

Memasang dokumen

	newDocument := struct {
		ID           string `json:"id"`
		CompanyName  string `json:"company_name"`
		NumEmployees int    `json:"num_employees"`
		Country      string `json:"country"`
	}{
		ID :           "123" ,
		CompanyName :  "Stark Industries" ,
		NumEmployees : 5215 ,
		Country :      "USA" ,
	}

	client . Collection ( "companies" ). Documents (). Upsert ( context . Background (), newDocument )

Cari koleksi

	searchParameters := & api. SearchCollectionParams {
		Q :        pointer . String ( "stark" ),
		QueryBy :  pointer . String ( "company_name" ),
		FilterBy : pointer . String ( "num_employees:>100" ),
		SortBy :   & ([] string { "num_employees:desc" }),
	}

	client . Collection ( "companies" ). Documents (). Search ( context . Background (), searchParameters )

untuk beberapa parameter QueryBy yang mendukung, Anda dapat menambahkan , setelah setiap bidang

	searchParameters := & api. SearchCollectionParams {
		Q :        pointer . String ( "stark" ),
		QueryBy :  pointer . String ( "company_name, country" ),
		FilterBy : pointer . String ( "num_employees:>100" ),
		SortBy :   & ([] string { "num_employees:desc" }),
	}

	client . Collection ( "companies" ). Documents (). Search ( context . Background (), searchParameters )

Ambil dokumen

 client . Collection ( "companies" ). Document ( "123" ). Retrieve ( context . Background ())

Perbarui dokumen

	document := struct {
		CompanyName  string `json:"company_name"`
		NumEmployees int    `json:"num_employees"`
	}{
		CompanyName :  "Stark Industries" ,
		NumEmployees : 5500 ,
	}

	client . Collection ( "companies" ). Document ( "123" ). Update ( context . Background (), document )

Hapus satu dokumen

 client . Collection ( "companies" ). Document ( "123" ). Delete ( context . Background ())

Hapus banyak dokumen

 filter := & api. DeleteDocumentsParams { FilterBy : "num_employees:>100" , BatchSize : 100 }
client . Collection ( "companies" ). Documents (). Delete ( context . Background (), filter )

Ambil koleksi

 client . Collection ( "companies" ). Retrieve ( context . Background ())

Ekspor dokumen dari koleksi

 client . Collection ( "companies" ). Documents (). Export ( context . Background ())

Impor dokumen ke dalam koleksi

Dokumen yang akan diimpor dapat berupa array objek dokumen atau diformat sebagai string JSON yang dibatasi baris baru (lihat JSONL).

Impor serangkaian dokumen:

	documents := [] interface {}{
		struct {
			ID           string `json:"id"`
			CompanyName  string `json:"companyName"`
			NumEmployees int    `json:"numEmployees"`
			Country      string `json:"country"`
		}{
			ID :           "123" ,
			CompanyName :  "Stark Industries" ,
			NumEmployees : 5215 ,
			Country :      "USA" ,
		},
	}
	params := & api. ImportDocumentsParams {
		Action :    pointer . String ( "create" ),
		BatchSize : pointer . Int ( 40 ),
	}

	client . Collection ( "companies" ). Documents (). Import ( context . Background (), documents , params )

Impor file JSONL:

	params := & api. ImportDocumentsParams {
		Action :    pointer . String ( "create" ),
		BatchSize : pointer . Int ( 40 ),
	}
	importBody , err := os . Open ( "documents.jsonl" )
	// defer close, error handling ...

	client . Collection ( "companies" ). Documents (). ImportJsonl ( context . Background (), importBody , params )

Daftar semua koleksi

 client . Collections (). Retrieve ( context . Background ())

Jatuhkan koleksi

 client . Collection ( "companies" ). Delete ( context . Background ())

Buat Kunci API

	keySchema := & api. ApiKeySchema {
		Description : "Search-only key." ,
		Actions :     [] string { "documents:search" },
		Collections : [] string { "companies" },
		ExpiresAt :   time . Now (). AddDate ( 0 , 6 , 0 ). Unix (),
	}

	client . Keys (). Create ( context . Background (), keySchema )

Ambil Kunci API

 client . Key ( 1 ). Retrieve ( context . Background ())

Daftar semua kunci

 client . Keys (). Retrieve ( context . Background ())

Hapus Kunci API

 client . Key ( 1 ). Delete ( context . Background ())

Membuat atau memperbarui penggantian

	override := & api. SearchOverrideSchema {
		Rule : api. SearchOverrideRule {
			Query : "apple" ,
			Match : "exact" ,
		},
		Includes : []api. SearchOverrideInclude {
			{
				Id :       "422" ,
				Position : 1 ,
			},
			{
				Id :       "54" ,
				Position : 2 ,
			},
		},
		Excludes : []api. SearchOverrideExclude {
			{
				Id : "287" ,
			},
		},
	}

	client . Collection ( "companies" ). Overrides (). Upsert ( context . Background (), "customize-apple" , override )

Buat daftar semua penggantian

 client . Collection ( "companies" ). Overrides (). Retrieve ( context . Background ())

Hapus penggantian

 client . Collection ( "companies" ). Override ( "customize-apple" ). Delete ( context . Background ())

Buat atau Perbarui alias

	body := & api. CollectionAliasSchema { CollectionName : "companies_june11" }
	client . Aliases (). Upsert ( "companies" , body )

Ambil alias

 client . Alias ( "companies" ). Retrieve ( context . Background ())

Daftar semua alias

 client . Aliases (). Retrieve ( context . Background ())

Hapus alias

 client . Alias ( "companies" ). Delete ( context . Background ())

Buat atau perbarui sinonim multi-arah

	synonym := & api. SearchSynonymSchema {
		Synonyms : [] string { "blazer" , "coat" , "jacket" },
	}
	client . Collection ( "products" ). Synonyms (). Upsert ( context . Background (), "coat-synonyms" , synonym )

Buat atau perbarui sinonim satu arah

	synonym := & api. SearchSynonymSchema {
		Root :     "blazer" ,
		Synonyms : [] string { "blazer" , "coat" , "jacket" },
	}
	client . Collection ( "products" ). Synonyms (). Upsert ( context . Background (), "coat-synonyms" , synonym )

Ambil sinonim

 client . Collection ( "products" ). Synonym ( "coat-synonyms" ). Retrieve ( context . Background ())

Daftar semua sinonim

 client . Collection ( "products" ). Synonyms (). Retrieve ( context . Background ())

Hapus sinonim

 client . Collection ( "products" ). Synonym ( "coat-synonyms" ). Delete ( context . Background ())

Buat atau perbarui kumpulan stopwords

	stopwords := & api. StopwordsSetUpsertSchema {
		Locale :    pointer . String ( "en" ),
		Stopwords : [] string { "Germany" , "France" , "Italy" , "United States" },
	}
	client . Stopwords (). Upsert ( context . Background (), "stopword_set1" , stopwords )

Ambil kumpulan stopwords

 client . Stopword ( "stopword_set1" ). Retrieve ( context . Background ())

Daftar semua kumpulan stopwords

 client . Stopwords (). Retrieve ( context . Background ())

Hapus kumpulan stopwords

 client . Stopword ( "stopword_set1" ). Delete ( context . Background ())

Membuat atau memperbarui preset

 preset := & api. PresetUpsertSchema {}
preset . Value . FromMultiSearchSearchesParameter (api. MultiSearchSearchesParameter {
		Searches : []api. MultiSearchCollectionParameters {
			{
				Collection : "books" ,
			},
		},
	})
// or: preset.Value.FromSearchParameters(api.SearchParameters{Q: "Books"})

client . Presets (). Upsert ( context . Background (), "listing-view-preset" , preset )

Ambil preset

 client . Preset ( "listing-view-preset" ). Retrieve ( context . Background ())

Daftar semua preset

 client . Presets (). Retrieve ( context . Background ())

Hapus preset

 client . Preset ( "listing-view-preset" ). Delete ( context . Background ())

Buat snapshot (untuk cadangan)

 client . Operations (). Snapshot ( context . Background (), "/tmp/typesense-data-snapshot" )

Pilih kembali Pemimpin

 client . Operations (). Vote ( context . Background ())

Metrik Klaster

 client . Metrics (). Retrieve ( context . Background ())

Statistik API

 client . Stats (). Retrieve ( context . Background ())

Berkontribusi

Laporan bug dan permintaan penarikan diterima di GitHub di https://github.com/typesense/typesense-go.

Pengaturan Alur Kerja Pengembangan

Instal dependensi,

go mod download

Perbarui file yang dihasilkan,

go generate ./...

Lisensi

typesense-go didistribusikan di bawah lisensi Apache 2.

Memperluas