Merge pull request #982 from sul-dlss/directions

Provide directions about making exports
sul-dlss · Jul 17, 2023 · e646c02 · e646c02
2 parents 515eaf7 + 76360fa
commit e646c02
Show file tree

Hide file tree

Showing 2 changed files with 93 additions and 72 deletions.
diff --git a/lib/traject/readers/folio_json_reader.rb b/lib/traject/readers/folio_json_reader.rb
@@ -3,7 +3,11 @@
 require 'traject_plus'
 
 module Traject
-  # A Traject reader for processing MARC JSON from FOLIO via stdin.
+  # A Traject reader for processing JSON exports from FOLIO via stdin.
+  # @example An export can be produced by doing:
+  #  require 'traject/readers/folio_postgres_reader'
+  #  record = Traject::FolioPostgresReader.find_by_catkey('a14238203', 'postgres.url' => ENV['DATABASE_URL']
+  #  File.write("a14238203.json", JSON.pretty_generate(record.as_json))
   class FolioJsonReader < TrajectPlus::JsonReader
     def each(&)
       return to_enum(:each) unless block_given?